Skip to content

Conversation

@janine-c
Copy link
Contributor

@janine-c janine-c commented Apr 2, 2025

What does this PR do? What is the motivation?

An attempt to make it possible to anchor directly to an accordion and have it open automatically.

Proof of concept example: https://docs-staging.datadoghq.com/janine.chan/hackathon-accordions/security/cloud_security_management/setup/agentless_scanning/enable#quick-start-setup

Merge instructions

Merge readiness:

  • Ready for merge

For Datadog employees:
Merge queue is enabled in this repo. Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). Without this format, your pull request will not pass in CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.

If your branch doesn't follow this format, rename it or create a new branch and PR.

To have your PR automatically merged after it receives the required reviews, add the following PR comment:

/merge

Additional notes

@janine-c janine-c added Do Not Merge Just do not merge this PR :) hackathon labels Apr 2, 2025
@janine-c janine-c requested a review from a team as a code owner April 2, 2025 18:41
@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Apr 2, 2025
@janine-c janine-c removed the Do Not Merge Just do not merge this PR :) label Apr 2, 2025
Co-authored-by: Brian Deutsch <bgdeutsch@gmail.com>
Co-authored-by: Brian Deutsch <bgdeutsch@gmail.com>
@janine-c janine-c requested a review from a team as a code owner April 3, 2025 17:23
@github-actions
Copy link
Contributor

github-actions bot commented Apr 3, 2025

Preview links (active after the build_preview check completes)

Modified Files

Copy link
Contributor

@estherk15 estherk15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very cool!

@janine-c
Copy link
Contributor Author

janine-c commented Apr 3, 2025

Hey @bgdeutsch 👋🏻 I did some things here:

  • For some reason, when I accepted your changes, the script stopped working in my local build. Changing const details = document.getElementById(hash) back to var details = document.getElementById(hash) fixed it after some trial and error, but I don't know enough about JavaScript to understand why. If I don't make that change, I get a Uncaught ReferenceError: details is not defined error in the console.
  • I added the IDs and links to a page I'd been working on before. I'm noticing an issue where the auto-scroll puts the top of the accordion behind the top nav, and I'm not sure how to fix that - I haven't seen that behaviour anywhere else in the docs. Here's an example: https://docs-staging.datadoghq.com/janine.chan/hackathon-accordions/security/cloud_security_management/setup/agentless_scanning/enable#quick-start-setup

Thanks as always for your expertise!

Signed-off-by: Brian Deutsch <brian.deutsch@datadoghq.com>
Signed-off-by: Brian Deutsch <brian.deutsch@datadoghq.com>
@janine-c
Copy link
Contributor Author

janine-c commented Apr 4, 2025

/merge

@dd-devflow
Copy link

dd-devflow bot commented Apr 4, 2025

View all feedbacks in Devflow UI.

2025-04-04 18:05:22 UTC ℹ️ Start processing command /merge


2025-04-04 18:05:29 UTC ℹ️ MergeQueue: waiting for PR to be ready

This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals.
Note: if you pushed new commits since the last approval, you may need additional approval.
You can remove it from the waiting list with /remove command.


2025-04-04 18:16:13 UTC ℹ️ MergeQueue: merge request added to the queue

The expected merge time in master is approximately 18m (p90).


2025-04-04 18:33:08 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit 528b4e4 into master Apr 4, 2025
17 of 20 checks passed
@dd-mergequeue dd-mergequeue bot deleted the janine.chan/hackathon-accordions branch April 4, 2025 18:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Architecture Everything related to the Doc backend hackathon mergequeue-status: done

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants