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

Website documentation should be versioned. #2488

Closed
bwplotka opened this issue Apr 21, 2020 · 10 comments
Closed

Website documentation should be versioned. #2488

bwplotka opened this issue Apr 21, 2020 · 10 comments

Comments

@bwplotka
Copy link
Member

As per our discussions here https://cloud-native.slack.com/archives/CL25937SP/p1585323322092300 and on Thanos Sync we agreed that we need improvement to our Hugo-based website that will allow exploring documentation part (docs/) per release version (and latest master) (:

Help wanted 🤗

Maybe good as GSoC/Community project.

AC:

  • (docs/ should be versioned under https://thanos.io/getting-started.md/ on our website for each minor releases (release-* branches) and master.
  • Allow user to tell in URL path what version to show.
  • By default show docs from the latest release
  • It should be easy to add new releases.

Ideally should be part as some preprocessing before Hugo, maybe as Go command (:

@bwplotka
Copy link
Member Author

bwplotka commented Apr 24, 2020

Cortex is doing the same 🤗 cortexproject/cortex#2349

@jaybatra26
Copy link

Hi!
We are trying to achieve something similar in Cortex. We have proposed to version specific pages to start with. We would sincerely appreciate feedback and suggestions on our proposal.

@jojohappy
Copy link
Member

Cortex is doing the same 🤗 cortexproject/cortex#2349

Cool!

@bwplotka
Copy link
Member Author

AFAIK @jaybatra26 is helping with proposal only. We are adding this project to Community Bridge. 🤗

@bwplotka
Copy link
Member Author

Rather like https://prometheus.io/docs/introduction/overview/ (:

image

@thisisobate
Copy link
Contributor

thisisobate commented May 1, 2020

Wow! @bwplotka This is the kind of issue I would love to contribute! I'm ready to help!
Drafting my first PR as soon as possible

@agarwalrounak
Copy link

Hi @bwplotka! I am interested to get mentored for this issue for the Community Bridge program.
Thus, I have applied as a mentee on the Community Bridge website for this project.
Hoping to getting interviewed and selected. Looking forward to it.

@bwplotka
Copy link
Member Author

bwplotka commented Jun 8, 2020

@thisisobate worth to check what Cortex did: cortexproject/cortex#2349

@stale
Copy link

stale bot commented Jul 8, 2020

Hello 👋 Looks like there was no activity on this issue for last 30 days.
Do you mind updating us on the status? Is this still reproducible or needed? If yes, just comment on this PR or push a commit. Thanks! 🤗
If there will be no activity for next week, this issue will be closed (we can always reopen an issue if we need!). Alternatively, use remind command if you wish to be reminded at some point in future.

@stale stale bot added the stale label Jul 8, 2020
@stale
Copy link

stale bot commented Jul 15, 2020

Closing for now as promised, let us know if you need this to be reopened! 🤗

@stale stale bot closed this as completed Jul 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants