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

docs: upgrade docs now reflect the new upgrade commands #1331

Merged
merged 2 commits into from
Mar 3, 2023

Conversation

derpsteb
Copy link
Member

@derpsteb derpsteb commented Mar 3, 2023

Proposed change(s)

  • The commands have changed greatly, thus I replaced the larger part of the upgrade docs.
  • I also replaced the term component(s) with microservice(s) when referring to our microservices. Since users are now faced with a config value called microserviceVersion, I feel like something should come up when searching the docs for "microservice".

Checklist

  • Update docs
  • Add labels (e.g., for changelog category)
  • Link to Milestone

@derpsteb derpsteb added the documentation Improvements or additions to documentation label Mar 3, 2023
@derpsteb derpsteb added this to the v2.6.0 milestone Mar 3, 2023
@derpsteb derpsteb requested a review from thomasten as a code owner March 3, 2023 08:07
@netlify
Copy link

netlify bot commented Mar 3, 2023

Deploy Preview for constellation-docs canceled.

Name Link
🔨 Latest commit c2959ca
🔍 Latest deploy log https://app.netlify.com/sites/constellation-docs/deploys/640206b5e29d7d000849cc54

docs/docs/architecture/microservices.md Show resolved Hide resolved
docs/docs/workflows/upgrade.md Outdated Show resolved Hide resolved
docs/docs/workflows/upgrade.md Outdated Show resolved Hide resolved
docs/docs/workflows/upgrade.md Outdated Show resolved Hide resolved
docs/docs/workflows/upgrade.md Outdated Show resolved Hide resolved
docs/docs/workflows/upgrade.md Outdated Show resolved Hide resolved
docs/docs/workflows/upgrade.md Outdated Show resolved Hide resolved
docs/docs/workflows/upgrade.md Outdated Show resolved Hide resolved
Copy link
Member

@thomasten thomasten left a comment

Choose a reason for hiding this comment

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

Thanks, LGTM! I'm still unsure if upgrades are sufficiently documented. But I can't tell anything specifically missing. We may learn from our users sometime ;)

derpsteb and others added 2 commits March 3, 2023 15:39
Since we now have a config value called microserviceVersion
it hopefully makes it easier for users to understand what
this value controls if we also use the term microservice
in the docs.
@derpsteb derpsteb merged commit 67a58bc into main Mar 3, 2023
@derpsteb derpsteb deleted the feat/upgrade-docs branch March 3, 2023 14:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants