-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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
Update Loki README with better links and descriptions #4088
Conversation
* [Most recent release](https://grafana.com/docs/loki/latest/) | ||
* [Not yet released documentation](https://grafana.com/docs/loki/next/), at the tip of the main branch | ||
|
||
### Documentation of old Loki versions |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Feels weird to keep this list around as it's not exhaustive, and we have the version dropdown in any case; maybe it's worthwhile pointing out that version selector instead?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These older docs are not available via the dropdown, as they weren't and aren't built for being hosted on a website. Do we even want to identify them for our Loki readers? We could just omit the links. Or, would an explanatory statement about why they're listed here be helpful? Something like: "Documentation for these older versions is not available on the Grafana documentation website. Find the documentation for these older versions via these links:"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm curious why they're not available via the docs site, but yes I think an explanatory statement could be good.
I also reckon we could move this way down to the bottom since it won't be germane for most users.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe this was before we had the current doc site generation tooling.
Co-authored-by: Danny Kopping <dannykopping@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, thanks @KMiller-Grafana!
@dannykopping: One more review, please. I added an explanatory comment about the hosting/not hosting of the old docs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @KMiller-Grafana!
* [Most recent release](https://grafana.com/docs/loki/latest/) | ||
* [Not yet released documentation](https://grafana.com/docs/loki/next/), at the tip of the main branch | ||
|
||
### Documentation of old Loki versions |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe this was before we had the current doc site generation tooling.
This PR changes the way the docs are described in links such that the README does not need to be updated as each new release is made.