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.

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

Adding section to avoid issue with Ci/CD #3725

Merged
merged 4 commits into from
May 6, 2024

Conversation

theburi
Copy link
Contributor

@theburi theburi commented Apr 26, 2024

Description

This is a change to help our customers avoid confusion with CI/CD configuration.

When should this change go live?

  • This change is not yet live and should not be merged until {ADD_DATE} (apply hold label or convert to draft PR)?
  • There is no urgency with this change.
  • This change or page is part of a marketing blog, conference talk, or something else on a schedule.
  • This functionality is already available but undocumented.
  • This is a bug fix or security concern.

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.

Copy link
Contributor

👋 🤖 🤔 Hello! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.5/.

  • docs/self-managed/setup/install.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

jessesimpson36
jessesimpson36 previously approved these changes Apr 29, 2024
aabouzaid
aabouzaid previously approved these changes Apr 29, 2024
@theburi theburi removed the hold This issue is parked, do not merge. label Apr 29, 2024
@christinaausley christinaausley added the component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed label Apr 29, 2024
@akeller
Copy link
Member

akeller commented May 1, 2024

@christinaausley, in addition to a review for style/grammar, do you have guidance on the secrets in code snippets? This might be something to add to the style guide.

@christinaausley
Copy link
Contributor

secrets in code snippets

I don't have a strong preference for this, so long as we are consistent. The hyphens and simple naming conventions work well -- will add to the style guide.

@akeller akeller merged commit ef72e60 into main May 6, 2024
6 checks passed
@akeller akeller deleted the ci-cd-installation-instructions branch May 6, 2024 21:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants