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

Migrate documentation: Add docs to etcd-io/website #99

Merged
merged 1 commit into from
Feb 2, 2021

Conversation

nate-double-u
Copy link
Contributor

@nate-double-u nate-double-u commented Jan 27, 2021

Adding current documentation from https://github.com/etcd-io/etcd/tree/master/Documentation to content/docs/current

  • Updating layout files to support new "current" version
  • Adding "current" version to deprecation warning (current + latest versions do not have warning)
  • Updating config

This addition uses documentation from commit etcd-io/etcd@a4fac14

fixes: #93

Deploy preview

Homepage: https://deploy-preview-99--etcd.netlify.app/
Docs index: https://deploy-preview-99--etcd.netlify.app/docs/current/
Deprecation sample: https://deploy-preview-99--etcd.netlify.app/docs/v3.3.13/demo/

@nate-double-u
Copy link
Contributor Author

Last push renames files to use "_" instead of "-" to be consistent with previous versions, like PR #89, but as we've not published this one yet, we don't need to update the redirects to protect bookmarks.

@nate-double-u
Copy link
Contributor Author

/cc @spzala

@nate-double-u
Copy link
Contributor Author

Should we add versioning instructions to this repo's README.md file?

@spzala
Copy link
Member

spzala commented Jan 29, 2021

Should we add versioning instructions to this repo's README.md file?

@nate-double-u since the etcd.io shows versioning, we should be fine not adding in the README but I would go with best practices and in line with other CNCF doc repos. We can make that changes later as needed. Thanks!

Copy link
Member

@spzala spzala left a comment

Choose a reason for hiding this comment

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

lgmt
Thanks @nate-double-u

@spzala
Copy link
Member

spzala commented Jan 29, 2021

/cc @gyuho @jingyih @ptabor - if you can take a quick look that would be great!

@nate-double-u
Copy link
Contributor Author

The last force-push:

Do we need to include:

  • content/docs/current/etcd-mixin/mixin.libsonnet
  • content/docs/current/dev-guide/apispec/swagger/rpc.swagger.json

Adding current documentation from https://github.com/etcd-io/etcd/tree/master/Documentation to content/docs/current

Updating layout files to support new "current" version

Updating config

fixes etcd-io#93

Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
@nate-double-u
Copy link
Contributor Author

last force-push is the same "-", "_" as above -- I'll catch it next time I promise 😅

Copy link

@jingyih jingyih left a comment

Choose a reason for hiding this comment

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

lgtm. Thanks!

@spzala spzala merged commit aec163d into etcd-io:master Feb 2, 2021
@nate-double-u nate-double-u deleted the 93-add-docs-to-website branch February 2, 2021 23:14
@nate-double-u
Copy link
Contributor Author

Thanks everyone!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Migrate documentation: Add docs to etcd-io/website
3 participants