Skip to content
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.

Sign up for GitHub

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

Jump to bottom

doc(sm): document self-manage troubleshooting scripts #3705

Merged
merged 18 commits into from
May 6, 2024
Merged

doc(sm): document self-manage troubleshooting scripts #3705

merged 18 commits into from
May 6, 2024

Conversation

leiicamundi
Copy link
Contributor

@leiicamundi leiicamundi commented Apr 23, 2024 •
edited

Description

This PR introduces a new section in the Troubleshooting documentation titled "Anomaly Detection Scripts". It provides an overview of the newly added scripts in the c8-sm-checks project, which aim to help in the detection of anomalies within C8 deployments for self-managed installations.

When should this change go live?

PR Checklist

  • I have added changes to the relevant /versioned_docs directory, or they are not for an already released version.
  • I have added changes to the main /docs directory (aka /next/), or they are not for future versions.
  • My changes require an Engineering review, and I've assigned an engineering manager or tech lead as a reviewer, or my changes do not require an Engineering review.
  • My changes require a technical writer review, and I've assigned @christinaausley as a reviewer, or my changes do not require a technical writer review.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 23, 2024 •
edited

👋 🤖 ✅ Looks like the changes were ported across versions, nice job! 🎉

You can read more about the versioning within our docs in our documentation guidelines.

github-actions[bot]
github-actions bot reviewed Apr 23, 2024
View reviewed changes
docs/self-managed/operational-guides/troubleshooting/troubleshooting.md Outdated Show resolved Hide resolved
docs/self-managed/operational-guides/troubleshooting/troubleshooting.md Outdated Show resolved Hide resolved
docs/self-managed/operational-guides/troubleshooting/troubleshooting.md Outdated Show resolved Hide resolved
docs/self-managed/operational-guides/troubleshooting/troubleshooting.md Outdated Show resolved Hide resolved
docs/self-managed/operational-guides/troubleshooting/troubleshooting.md Outdated Show resolved Hide resolved
docs/self-managed/operational-guides/troubleshooting/troubleshooting.md Outdated Show resolved Hide resolved
docs/self-managed/operational-guides/troubleshooting/troubleshooting.md Outdated Show resolved Hide resolved
@leiicamundi leiicamundi marked this pull request as ready for review April 23, 2024 14:50
@leiicamundi leiicamundi mentioned this pull request Apr 23, 2024
Merged
github-actions[bot]
github-actions bot reviewed Apr 23, 2024
View reviewed changes
versioned_docs/version-8.5/self-managed/operational-guides/troubleshooting/troubleshooting.md Outdated Show resolved Hide resolved
versioned_docs/version-8.5/self-managed/operational-guides/troubleshooting/troubleshooting.md Outdated Show resolved Hide resolved
versioned_docs/version-8.5/self-managed/operational-guides/troubleshooting/troubleshooting.md Outdated Show resolved Hide resolved
versioned_docs/version-8.5/self-managed/operational-guides/troubleshooting/troubleshooting.md Outdated Show resolved Hide resolved
versioned_docs/version-8.5/self-managed/operational-guides/troubleshooting/troubleshooting.md Outdated Show resolved Hide resolved
versioned_docs/version-8.5/self-managed/operational-guides/troubleshooting/troubleshooting.md Outdated Show resolved Hide resolved
versioned_docs/version-8.5/self-managed/operational-guides/troubleshooting/troubleshooting.md Outdated Show resolved Hide resolved
leiicamundi and others added 3 commits April 23, 2024 18:07
@leiicamundi @github-actions
Update docs/self-managed/operational-guides/troubleshooting/troublesh…
7e32449 
…ooting.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@leiicamundi @github-actions
Update docs/self-managed/operational-guides/troubleshooting/troublesh…
9f409b8 
…ooting.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@leiicamundi @github-actions
Apply suggestions from code review
f828166 
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@leiicamundi @github-actions
Update versioned_docs/version-8.5/self-managed/operational-guides/tro…
d48a457 
…ubleshooting/troubleshooting.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Langleu
Langleu previously approved these changes Apr 24, 2024
View reviewed changes
Copy link
Member

@Langleu Langleu left a comment

Choose a reason for hiding this comment

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

looks good content wise from my side 👍.
Good job 🚀

@leiicamundi @github-actions
Update versioned_docs/version-8.5/self-managed/operational-guides/tro…
40d75dc 
…ubleshooting/troubleshooting.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@leiicamundi @github-actions
Update versioned_docs/version-8.5/self-managed/operational-guides/tro…
1f85aea 
…ubleshooting/troubleshooting.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Langleu
Langleu previously approved these changes Apr 25, 2024
View reviewed changes
@christinaausley christinaausley added the component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed label Apr 26, 2024
@leiicamundi
Copy link
Contributor Author

Following modifications made by camunda/c8-sm-checks#8, I replaced mentions of [KO] by [FAIL]

@leiicamundi leiicamundi mentioned this pull request Apr 29, 2024
Merged
christinaausley
christinaausley previously approved these changes Apr 29, 2024
View reviewed changes
Copy link
Contributor

@christinaausley christinaausley left a comment

Choose a reason for hiding this comment

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

I like this change -- helps differentiate for sure.

Langleu
Langleu requested changes Apr 30, 2024
View reviewed changes
Copy link
Member

@Langleu Langleu left a comment

Choose a reason for hiding this comment

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

some small minor rephrasing requests.

Langleu
Langleu previously approved these changes Apr 30, 2024
View reviewed changes
@leiicamundi
Copy link
Contributor Author

Hey @christinaausley; following requested adjustments could you kindly review the kubernetes requirements section that was added in c3b6cd5? Thank you in advance!

@leiicamundi
Copy link
Contributor Author

Thanks for the review and the adjustments @christinaausley :)

@leiicamundi leiicamundi merged commit 664150d into main May 6, 2024
6 checks passed
@leiicamundi leiicamundi deleted the feature/sm-checks-troubleshoot branch May 6, 2024 08:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions github-actions[bot] github-actions left review comments

@christinaausley christinaausley christinaausley approved these changes

@Langleu Langleu Langleu left review comments

Assignees

@leiicamundi leiicamundi

Labels
component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@leiicamundi @Langleu @christinaausley