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

Update Local deployment guide with connectivity topics #3509

Merged
merged 6 commits into from
Apr 5, 2024

Conversation

theburi
Copy link
Contributor

@theburi theburi commented Mar 22, 2024

Description

My goal is to improve the local deployment guide to help users do E2E

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.4/.

  • docs/self-managed/platform-deployment/helm-kubernetes/guides/local-kubernetes-cluster.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.

@christinaausley christinaausley added the component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed label Mar 25, 2024
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.

A few comments to clarify a few sections.

Additionally, I'm not sure we need to break this up into tabs. I think we can keep everything within a single file here, particularly given the trouble we've been having with deep-linking to tabbed content lately.

@theburi
Copy link
Contributor Author

theburi commented Mar 26, 2024

A few comments to clarify a few sections.

Additionally, I'm not sure we need to break this up into tabs. I think we can keep everything within a single file here, particularly given the trouble we've been having with deep-linking to tabbed content lately.

I find one large file gets newcomers confused as it's hard to follow, and ignore sections. Tabs create a single flow, hiding sections and avoiding confusion.
In this particular case, we would not link to these tabs as we have other articles explaining these topics in all detail.

@christinaausley
Copy link
Contributor

Is this linked to a particular issue and is this for next or the 8.5 release only?

Copy link
Member

@aabouzaid aabouzaid left a comment

Choose a reason for hiding this comment

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

LGTM, thank you 👍

@theburi theburi merged commit 1dc3443 into main Apr 5, 2024
6 checks passed
@theburi theburi deleted the local-deployment-connectivity branch April 5, 2024 10:45
theburi added a commit that referenced this pull request Jun 5, 2024
* First pass on local deployment and adding ingress configuration

* style(formatting): technical review

* Several  fixed

* adding links to ingress

* minor adjustments

---------

Co-authored-by: Christina Ausley <[email protected]>
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.

4 participants