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

doc(helm-guides): add example app installation #3508

Merged
merged 12 commits into from
Apr 16, 2024

Conversation

leiicamundi
Copy link
Contributor

Description

This PR extends the existing EKS guide by incorporating the demo payment example C8 application, developed by @ingorichtsmeier, which serves as a validation tool for the C8 stack. The objective is to showcase a working example within the EKS environment.

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.

@leiicamundi leiicamundi added the best-practices Issues related to the Best Practices section of the docs label Mar 22, 2024
@leiicamundi leiicamundi requested a review from Langleu March 22, 2024 15:34
@leiicamundi leiicamundi self-assigned this Mar 22, 2024
@leiicamundi leiicamundi added the hold This issue is parked, do not merge. label Mar 22, 2024
@maxdanilov maxdanilov added the component:infex Issues related with InfEx project label Mar 25, 2024
Copy link
Member

@maxdanilov maxdanilov left a comment

Choose a reason for hiding this comment

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

(Reviewing this PR instead of Lars)

I've left some comments on the wording. Additional thing missing in this PR, is that the new pages (in order to appear on the left sidebar in the table of contents) need to be added to https://github.com/camunda/camunda-docs/blob/main/sidebars.js and https://github.com/camunda/camunda-docs/blob/main/optimize_sidebars.js in the corresponding version branches.

@maxdanilov maxdanilov removed the request for review from Langleu March 25, 2024 12:50
optimize_sidebars.js Outdated Show resolved Hide resolved
@christinaausley
Copy link
Contributor

@leiicamundi is this still in draft because you have additional changes coming? Let me know when you are ready for final review. We can pull this out of draft if there are no additional large changes, as the hold label is sufficient.

@leiicamundi
Copy link
Contributor Author

Hey @christinaausley, yes this is still a draft, we are waiting until camunda-community-hub/camunda-8-examples#342 is merged. Until that, this PR should remain stalled

leiicamundi and others added 8 commits April 11, 2024 16:45
…nstalling-payment-example.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
…lm-kubernetes/guides/installing-payment-example.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
…lm-kubernetes/guides/installing-payment-example.md

Co-authored-by: Maxim Danilov <[email protected]>
…lm-kubernetes/guides/installing-payment-example.md

Co-authored-by: Maxim Danilov <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@leiicamundi leiicamundi force-pushed the feature/payment-example-app branch from c6ca9d1 to 82ade83 Compare April 11, 2024 14:58
@leiicamundi leiicamundi requested a review from maxdanilov April 11, 2024 14:59
@leiicamundi leiicamundi marked this pull request as ready for review April 11, 2024 14:59
@leiicamundi
Copy link
Contributor Author

Hello @maxdanilov, @christinaausley

The PR camunda-community-hub/camunda-8-examples#342 is now merged! I've rebased this PR branch onto the latest main and done the necessary adjustment for the new doc structure.

Could you please review it? Thank you in advance! ;)

Copy link
Member

@maxdanilov maxdanilov left a comment

Choose a reason for hiding this comment

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

Content-wise LGTM, one missing thing is sidebars (they are versioned as well), in this case:

@leiicamundi
Copy link
Contributor Author

Ty @maxdanilov, I hadn't seen that the sidebar was versioned, fixed by 4a2d278

maxdanilov
maxdanilov previously approved these changes Apr 12, 2024
@maxdanilov maxdanilov removed the hold This issue is parked, do not merge. label Apr 12, 2024
@christinaausley
Copy link
Contributor

I'll get this reviewed today 👍

@leiicamundi leiicamundi enabled auto-merge (squash) April 16, 2024 17:01
@leiicamundi leiicamundi merged commit 2bb39b1 into main Apr 16, 2024
6 checks passed
@leiicamundi leiicamundi deleted the feature/payment-example-app branch April 16, 2024 17:04
theburi pushed a commit that referenced this pull request Jun 5, 2024
* doc(helm-guides): add example app installation

* Update docs/self-managed/platform-deployment/helm-kubernetes/guides/installing-payment-example.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update versioned_docs/version-8.4/self-managed/platform-deployment/helm-kubernetes/guides/installing-payment-example.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update versioned_docs/version-8.4/self-managed/platform-deployment/helm-kubernetes/guides/installing-payment-example.md

Co-authored-by: Maxim Danilov <[email protected]>

* Update versioned_docs/version-8.4/self-managed/platform-deployment/helm-kubernetes/guides/installing-payment-example.md

Co-authored-by: Maxim Danilov <[email protected]>

* doc(helm-guides): update payment app example

* Update optimize_sidebars.js

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* doc(sm): payment app example updated with new doc structure

* doc(sm): payment app example add versioned sidebars

* style(formatting): technical review

* style(formatting): shorten title

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Maxim Danilov <[email protected]>
Co-authored-by: Christina Ausley <[email protected]>
Co-authored-by: christinaausley <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
best-practices Issues related to the Best Practices section of the docs component:infex Issues related with InfEx project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants