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

Use only real version names, not next, for doc version subdirectories under /content #252

Open
chalin opened this issue Apr 26, 2021 · 6 comments
Labels
e1-hours Effort: < 8 hrs p1-high

Comments

@chalin
Copy link
Contributor

chalin commented Apr 26, 2021

@spzala et al: I'd like to propose that all our doc version subfolders name the version they are targeting. That is currently the case except for the special /docs/next.

Some drawbacks of using /docs/next as part of permalinks include the following:

  • This muddles analytics
  • It makes releasing a new version of the docs a bit more work. For details, see the following threads:
  • In my opinion, it can confuse site users as explained next:
    Let's suppose that we just released v3.5 docs, under the current scheme we'd already have a /docs/next even though there are no v3.6.x-DRAFT docs. Under the new scheme we can either, not create v3.6 until we have v3.6 docs, or we can immediately create the branch but mark it as draft and not publish it (until we have actual v3.6 specific changes).

Some advantages of using only a version name for doc-version subfolders:

  • We can have more than one "next". For example, etcd currently has v3.5 and v4.0 under development.

We can, of course, keep /docs/next as a virtual path that is redirected to the/a "next" release of the docs.

Thoughts?

Related:

Following, #336, we'll need to consider the impact (and possible improvements) to the Makefile.

/cc @nate-double-u

@nate-double-u
Copy link
Contributor

Setting e1-hours and p1-high. I don't think this will take that long to do, but it's important that we make a decision around how we name our upcoming versions moving forward.

@nate-double-u
Copy link
Contributor

I agree with the proposal that all our doc version subfolders name the version they are targeting.

@chalin
Copy link
Contributor Author

chalin commented May 21, 2021

Think about this more, an alternative would be to keep next but define a redirect rule based on the eventual version that next will be.

@chalin
Copy link
Contributor Author

chalin commented May 28, 2021

All: as a step in this direction, we'll be implementing the proposal (in the opening comment) as part of the preparation for the v3.5 docs; see #332. /cc @spzala @ptabor

@nate-double-u nate-double-u self-assigned this Jun 3, 2021
@nate-double-u nate-double-u added the in progress Indicates that an Issue is actively being worked on. label Jun 3, 2021
@nate-double-u nate-double-u removed their assignment Jun 14, 2021
@nate-double-u nate-double-u removed the in progress Indicates that an Issue is actively being worked on. label Jun 16, 2021
@nate-double-u
Copy link
Contributor

Note, currently there is no next. Since the v3.5 release, next points to the same folder as latest.

@nate-double-u
Copy link
Contributor

Related conversation:
etcd-io/etcd#13110 (comment) (@ptabor)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
e1-hours Effort: < 8 hrs p1-high
Projects
None yet
Development

No branches or pull requests

2 participants