Skip to content

fix: add diagnistics script to sidebars #5741

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 9, 2025

Conversation

hisImminence
Copy link
Contributor

@hisImminence hisImminence commented May 8, 2025

Description

This fix adds the diagnostic script to the sidebars of version 8.4-8.7 (it was missed in the prior PR https://github.com/camunda/camunda-docs/pull/5683/files and only added to the sidebar of 8.8)

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support. (add bug or support label)
  • This is already available but undocumented and should be released within a week. (add available & undocumented label)
  • This is on a specific schedule and the assignee will coordinate a release with the Documentation team. (create draft PR and/or add hold label)
  • This is part of a scheduled alpha or minor. (add alpha or minor label)
  • There is no urgency with this change (add low prio label)

PR Checklist

  • My changes are for an upcoming minor release and are in the /docs directory (version 8.8).
  • My changes are for an already released minor and are in a /versioned_docs directory.

@hisImminence hisImminence requested a review from a team May 8, 2025 15:37
@hisImminence hisImminence added the deploy Stand up a temporary docs site with this PR label May 8, 2025
@akeller akeller moved this to 👀 In Review in Documentation Team May 8, 2025
@github-actions github-actions bot temporarily deployed to camunda-docs May 8, 2025 15:45 Destroyed
@hisImminence
Copy link
Contributor Author

Confirmed that all scripts are showing now up in the sidebar of the versions!

@hisImminence hisImminence marked this pull request as ready for review May 8, 2025 15:58
@@ -1083,7 +1083,8 @@
"self-managed/platform-deployment/helm-kubernetes/guides/installing-payment-app-example"
]
},
"self-managed/platform-deployment/troubleshooting"
"self-managed/platform-deployment/troubleshooting",
"self-managed/platform-deployment/diagnostics"
Copy link
Contributor

Choose a reason for hiding this comment

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

@hisImminence Does this page exist in 8.4? I'm not sure this should be in the 8.4 sidebar?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh you are right - moved it under the operational-guide! Thanks!

Copy link
Contributor

Choose a reason for hiding this comment

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

@hisImminence I saw the problem was in the file path, so I've adjusted it to point to the platform-deployment path, and it now appears in the sidebar under troubleshooting as I think you wanted? We don't need to move it for 8.4 as that would need redirects etc - I think this is the sidebar behaviour you were after?
image

@hisImminence hisImminence enabled auto-merge (squash) May 8, 2025 17:03
@github-actions github-actions bot temporarily deployed to camunda-docs May 9, 2025 08:57 Destroyed
@mesellings mesellings self-requested a review May 9, 2025 09:11
Copy link
Contributor

@mesellings mesellings left a comment

Choose a reason for hiding this comment

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

Assuming the sidebar fix is correct, happy to approve! 🚀

One thing @hisImminence is that I notice the changes to the 8.8 file following review of #5683 were not propagated to 8.4 -8.7 - we should create a new docs issue to fix this, unless you want to handle it in this PR? Would you like me to take this?

@hisImminence hisImminence merged commit d26f181 into main May 9, 2025
10 checks passed
@hisImminence hisImminence deleted the fix-sidebar-for-diagnostics-script branch May 9, 2025 09:14
@github-project-automation github-project-automation bot moved this from 👀 In Review to ✅ Done in Documentation Team May 9, 2025
Copy link
Contributor

github-actions bot commented May 9, 2025

🧹 Preview environment for this PR has been torn down.

@mesellings
Copy link
Contributor

@hisImminence TW review comments backport work for 8.4-8.7 covered in #5753

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deploy Stand up a temporary docs site with this PR
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants