Skip to content

Clarified Page "Upgrading etcd clusters and applications" #986

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Clarified Page "Upgrading etcd clusters and applications" #986

wants to merge 4 commits into from

Conversation

ronaldngounou
Copy link

Overview

This PR aimes to fix issue #773 .
I deleted removed the "Upgrading etcd clusters and applications" page.
I created a folder located in content/en/docs/v3.5/upgrades/archives_upgrades to contain upgrade archives. I added the upgrades from 2.3 to 3.0, namely upgrade_3_0.md to that folder.

A second task related to this issue aims to list at the top of the "Upgrading" main page, document which upgrade paths are supported, recommended, deprecated, and unsupported.
I would suggest adding these versions in the list as I am waiting for approval.
recommended: [3.5.21] deprecated: [3.1, 3.2, 3.3, 3.4] unsupported: [2.3 to 3.0]

Testing

npm run serve

github-actions bot and others added 3 commits April 16, 2025 00:02
@github-actions @ronaldngounou
[v3.4] Update installation version to latest tag (v3.4.36)
2d811c0 
cc. @etcd-io/maintainers-website

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

Fix lint error in 3.5 downgrade instructions.

Signed-off-by: Siyuan Zhang <sizhang@google.com>

[v3.5] Update installation version to latest tag (v3.5.19)

cc. @etcd-io/maintainers-website

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

add a blog post to summary the upgrade from 3.5 to 3.6 issue

Signed-off-by: Benjamin Wang <benjamin.ahrtr@gmail.com>

[v3.5] Update installation version to latest tag (v3.5.21)

cc. @etcd-io/maintainers-website

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

Add section Embedding etcd in a Go Application

Signed-off-by: Ronald Ngounou <74538524+ronaldngounou@users.noreply.github.com>

Fix markdown lint errors

Signed-off-by: Ronald Ngounou <74538524+ronaldngounou@users.noreply.github.com>

rewrite Quickstart for local etcd setup

Signed-off-by: Ronald Ngounou <74538524+ronaldngounou@users.noreply.github.com>

Fix quickstart page to respect markdownlint normalization rules

Signed-off-by: Ronald Ngounou <74538524+ronaldngounou@users.noreply.github.com>

Add package json to gitignore

Signed-off-by: Ronald Ngounou <74538524+ronaldngounou@users.noreply.github.com>

Fix lint error related to website references

Signed-off-by: Ronald Ngounou <74538524+ronaldngounou@users.noreply.github.com>

Fix lint error: files should end with a single line character

Signed-off-by: Ronald Ngounou <74538524+ronaldngounou@users.noreply.github.com>

issue980 Revise the Whats next section to focus on two separate paths

Signed-off-by: Ronald Ngounou <74538524+ronaldngounou@users.noreply.github.com>

Revise how to create locks section

Signed-off-by: Ronald Ngounou <74538524+ronaldngounou@users.noreply.github.com>

Fix quickstart page to respect markdownlint normalization rules

Signed-off-by: Ronald Ngounou <74538524+ronaldngounou@users.noreply.github.com>

Add package json to gitignore

Signed-off-by: Ronald Ngounou <74538524+ronaldngounou@users.noreply.github.com>

Revise how to create locks section

Signed-off-by: Ronald Ngounou <74538524+ronaldngounou@users.noreply.github.com>

Fix quickstart page to respect markdownlint normalization rules

Signed-off-by: Ronald Ngounou <74538524+ronaldngounou@users.noreply.github.com>

Add package json to gitignore

Signed-off-by: Ronald Ngounou <74538524+ronaldngounou@users.noreply.github.com>

Fix lint error related to website references

Signed-off-by: Ronald Ngounou <74538524+ronaldngounou@users.noreply.github.com>

Fix lint error: files should end with a single line character

Signed-off-by: Ronald Ngounou <74538524+ronaldngounou@users.noreply.github.com>

issue980 Revise the Whats next section to focus on two separate paths

Signed-off-by: Ronald Ngounou <74538524+ronaldngounou@users.noreply.github.com>
@ronaldngounou
Delete Upgrading etcd clusters and applications page
77978b8 
Signed-off-by: Ronald Ngounou <74538524+ronaldngounou@users.noreply.github.com>
@ronaldngounou
Archive upgrade documentation from 2.3 to 3.0
1243ffa 
Signed-off-by: Ronald Ngounou <74538524+ronaldngounou@users.noreply.github.com>
@k8s-ci-robot
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: ronaldngounou
Once this PR has been reviewed and has the lgtm label, please assign serathius for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot
Copy link

Hi @ronaldngounou. Thanks for your PR.

I'm waiting for a etcd-io member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@jberkus
Copy link
Contributor

jberkus commented Apr 22, 2025

Hey Ronald! Thanks so much for this.

For this and your other PRs, we're training some new documentation reviewers in the next couple weeks, so I'm going to hold some of your PRs so that we can use them for training. Hope that's OK.

/ok-to-test

@k8s-ci-robot
Copy link

@ronaldngounou: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-website-lint 9360dc7 link true /test pull-website-lint

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

jberkus
jberkus reviewed Apr 23, 2025
View reviewed changes
.gitignore
@@ -16,3 +16,4 @@ tmp/
# IDEs
.idea
*.iml
package.json
Copy link
Contributor

Choose a reason for hiding this comment

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

This is an example of the "extra files" I was talking about. This definitely shouldn't be in this PR.

jberkus
jberkus reviewed Apr 23, 2025
View reviewed changes
content/en/docs/v3.1/upgrades/upgrade_3_3.md
Copy link
Contributor

Choose a reason for hiding this comment

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

It looks like the only things you changed in this file was spacing? Probably automatic from your text editor. If that's the case, please exclude this from your commit.

jberkus
jberkus reviewed Apr 23, 2025
View reviewed changes
content/en/docs/v3.4/_index.md
@@ -2,7 +2,7 @@
title: v3.4 docs
cascade:
version: &vers v3.4
git_version_tag: v3.4.37
git_version_tag: v3.4.36
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't understand why you're reverting this? 3.4.37 is current.

jberkus
jberkus reviewed Apr 23, 2025
View reviewed changes
content/en/docs/v3.5/dev-guide/golang_embed_pkg.md
Copy link
Contributor

Choose a reason for hiding this comment

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

This feels like it got imported from another PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jberkus jberkus jberkus left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
ok-to-test size/L
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ronaldngounou @k8s-ci-robot @jberkus