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

[DRAFT] Implement alternate SM install journey #4601

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

conceptualshark
Copy link
Contributor

Description

⚠️ draft - do not merge

This PR will be for soliciting feedback on alternate setups + next steps for the SM installation user journey,

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@conceptualshark conceptualshark added component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed deploy Stand up a temporary docs site with this PR labels Nov 13, 2024
Copy link
Contributor

github-actions bot commented Nov 13, 2024

👋 🤖 🤔 Hello, @conceptualshark! 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.6/.

  • docs/self-managed/about-self-managed.md
  • docs/self-managed/setup/install.md
  • docs/self-managed/setup/overview.md
  • docs/self-managed/setup/upgrade.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 github-actions bot temporarily deployed to camunda-docs November 13, 2024 21:10 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs November 22, 2024 22:24 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs December 6, 2024 21:00 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs December 20, 2024 14:00 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs December 20, 2024 15:22 Destroyed
@conceptualshark
Copy link
Contributor Author

@theburi I don't think this represents the final state, just an initial cutover to a new structure before we introduce any content changes. Here's a few outstanding items:

  • Right now, "Reference architecture" is nested under "Deploy," but I think these could be better merged as the content is updated.
  • In the initial miro draft, "Deploy" was not recommended, but I still think it makes more sense for the user experience. Users in the SM docs are going to be looking for instructions on how to deploy a SM distribution; they may not recognize that there is any overlap with Deploying in Modeler, as their use cases are different. I think the audiences will be sufficiently different to know what they're looking for here, and Deploy is the most descriptive. We also currently use Deploy as a section under Setup, and haven't had any reported confusion there yet.
  • I'd like to create a few more landing pages, likely in a follow-up PR: some summary content for getting started, update the installation landing page, a new/updated Deploy landing page, and one for Update to describe the difference between the two guides here (Helm vs not Helm).
  • Nothing in operational guides, components, etc, is touched yet in this PR - only the initial install/onboarding experience.

@conceptualshark conceptualshark marked this pull request as ready for review December 20, 2024 21:32
@github-actions github-actions bot temporarily deployed to camunda-docs December 20, 2024 21:38 Destroyed
Copy link
Contributor

The preview environment relating to the commit 7a6fb94 has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-4601/index.html

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 deploy Stand up a temporary docs site with this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant