camunda-docs icon indicating copy to clipboard operation
camunda-docs copied to clipboard

Adding section to avoid issue with Ci/CD

Open theburi opened this issue 1 year ago • 3 comments

Description

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

When should this change go live?

  • [X] 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.
  • [X] 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.

theburi avatar Apr 26 '24 13:04 theburi

:wave: :robot: :thinking: 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.

github-actions[bot] avatar Apr 26 '24 13:04 github-actions[bot]

@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.

akeller avatar May 01 '24 17:05 akeller

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.

christinaausley avatar May 06 '24 16:05 christinaausley