Skip to content

Instantly share code, notes, and snippets.

@kiyoto

kiyoto/fluentd-docs-versioning.markdown

Last active August 29, 2015 14:10
Show Gist options
  • Save kiyoto/e51317565ca5995a6797 to your computer and use it in GitHub Desktop.
Save kiyoto/e51317565ca5995a6797 to your computer and use it in GitHub Desktop.
Download ZIP
Versioning Fluentd's Documentation
Raw
fluentd-docs-versioning.markdown

Versioning Fluentd's Documentation

As Fluentd starts rolling out new major uprates (v0.12 & v0.14) and inches towards the v1 release, I want to re-organize and version the docs website

Here is my plan.

  1. All current URLs will start pointing to the latest release. This does NOT include preview releases.

  2. For each page, the version information is embedded as follows: https://docs.fluentd.org/<LANGUAGE>/<VERSION>/<PAGE_NAME>. Ex. https://docs.fluentd.org/ja/v0-12/config-file. The pages that have version info in the URL are called Versioned Pages.

  3. For each Versioned Page that is not the latest version, the following warning shows up on the page:

    This articles is for Fluentd <OLD VERSION>. For the latest version of this article, please go <URL OF THE LATEST VERSION>.

Feedback is appreciated.

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