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.

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

Simplify how versions are configured in front matter #322

Open
chalin opened this issue May 26, 2021 · 2 comments
Open

Simplify how versions are configured in front matter #322

chalin opened this issue May 26, 2021 · 2 comments
Assignees
@nate-double-u
Labels
in progress Indicates that an Issue is actively being worked on. infrastructure Categorizes issue or PR as related to site infrastructure.

Comments

@chalin
Copy link
Contributor

chalin commented May 26, 2021

Simplify how versions are configured in front matter, especially for next/_index.html. This is what the front matter looks like now:

---
title: v3.5-DRAFT docs
cascade:
  version: next
  versName: &name v3.5-DRAFT
  git_version_tag: v3.5.0-beta.4
  page_warning: the documentation is in **DRAFT** status.
linkTitle: *name
---

I'd like to be able to use version in the Install page, for example, but I can't atm because it is currently the permalink alias. I'm leaning more and more towards #252, as a partial way of contributing to a solution to this issue too.

Other ideas:

  • Separate out the status as, e.g., versStatus: DRAFT. For older doc versions we could use ARCHIVE

Related: #252, #296, #300, #302, #304
@chalin chalin added the infrastructure Categorizes issue or PR as related to site infrastructure. label May 26, 2021
@chalin chalin mentioned this issue May 26, 2021
Closed
9 tasks
@chalin
Copy link
Contributor Author

chalin commented May 27, 2021 •
edited
Loading

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

@chalin chalin mentioned this issue May 28, 2021
Closed
@chalin
Copy link
Contributor Author

chalin commented May 28, 2021

Regarding page warnings, I like the terminology used by https://velero.io/docs/main/. (Though I still think that we shouldn't have a next site folder.)

@nate-double-u nate-double-u self-assigned this Jun 2, 2021
@nate-double-u nate-double-u added the in progress Indicates that an Issue is actively being worked on. label Jun 2, 2021
@nate-double-u nate-double-u mentioned this issue Jun 3, 2021
Closed
@nate-double-u nate-double-u linked a pull request Jun 9, 2021 that will close this issue
Simplifying how versions are configured in front matter #354
Closed
@nate-double-u nate-double-u mentioned this issue Jun 15, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nate-double-u nate-double-u

Labels
in progress Indicates that an Issue is actively being worked on. infrastructure Categorizes issue or PR as related to site infrastructure.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Simplifying how versions are configured in front matter etcd-io/website
2 participants
@chalin @nate-double-u