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

Update Loki README with better links and descriptions #4088

Merged
merged 3 commits into from
Aug 9, 2021

Conversation

KMiller-Grafana
Copy link
Contributor

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.

@KMiller-Grafana KMiller-Grafana requested a review from a team as a code owner August 2, 2021 18:57
README.md Outdated Show resolved Hide resolved
* [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
Copy link
Contributor

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?

Copy link
Contributor Author

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:"

Copy link
Contributor

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.

Copy link
Member

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>
Copy link
Contributor

@dannykopping dannykopping left a 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!

@pull-request-size pull-request-size bot added size/M and removed size/S labels Aug 6, 2021
@KMiller-Grafana
Copy link
Contributor Author

@dannykopping: One more review, please. I added an explanatory comment about the hosting/not hosting of the old docs.

Copy link
Contributor

@dannykopping dannykopping left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

* [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
Copy link
Member

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.

@owen-d owen-d merged commit 420798d into grafana:main Aug 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants