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

README: update / drop "releasing a new version of docs" section #144

Closed
chalin opened this issue Mar 24, 2021 · 2 comments · Fixed by #167
Closed

README: update / drop "releasing a new version of docs" section #144

chalin opened this issue Mar 24, 2021 · 2 comments · Fixed by #167
Assignees

Comments

@chalin
Copy link
Contributor

chalin commented Mar 24, 2021

Since #93, I don't think that the following text from the README.md is accurate anymore, right @nate-double-u?

Releasing a new version of the etcd documentation

In order to add documentation for a version of etcd, you need to:

  • Navigate to the etcd-io/etcd repo and checkout the tag for the version, for example git checkout v3.3.12.

  • Copy the Documentation directory from the main etcd repo into the content/docs directory of this repository, renaming the directory to match the version. Here's an example for (non-existing) version 4.3.2:

    cp -rf /path/to/etcd-io/etcd/Documentation /path/to/etcd-io/website/content/docs/v4.3.2
  • In the _index.md file at the root of the new directory, update the title metadata to reflect the new version. The title should read etcd version <new-version>.

  • Add the version to the params.versions.all array in the config.toml configuration file.

  • If the version is meant to be the latest version of etcd, change the params.versions.latest parameter to the desired new version.

  • Submit a pull request with the changes.

@nate-double-u nate-double-u added the docsy Categorizes issue or PR as related to the docsy conversion project. label Mar 24, 2021
@nate-double-u
Copy link
Contributor

I agree, we'll need to update the README - i've added this issue to our omni-issue #134

@chalin
Copy link
Contributor Author

chalin commented Mar 24, 2021

IMHO, at least part of this should be fixed on the main branch.

@nate-double-u nate-double-u added cleanup/refactoring and removed docsy Categorizes issue or PR as related to the docsy conversion project. labels Mar 24, 2021
@nate-double-u nate-double-u self-assigned this Mar 26, 2021
@nate-double-u nate-double-u modified the milestone: 21Q2-docsy Apr 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants