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

Fix rendering of table of contents using the local web server #1043

Merged
merged 3 commits into from
Feb 8, 2022

Conversation

jdbaldry
Copy link
Member

@jdbaldry jdbaldry commented Feb 4, 2022

Ensure Mimir has an index file for proper table of contents rendering

Ensure make docs can be run from the /docs directory

This is consistent with other Grafana labs project. The include in the
top-level Makefile is updated to allow it to also be run from the root
of the repository.

Supersedes #1041.

Fixes https://github.com/grafana/mimir-squad/issues/523

Without the _index.md file, the table of contents doesn't expand as it
does with the public website.

Signed-off-by: Jack Baldry <[email protected]>
This is consistent with other Grafana labs project. The include in the
top-level Makefile is updated to allow it to also be run from the root
of the repository.

Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry jdbaldry changed the title Jdb/2022 02 fix table of contents Fix rendering of table of contents using the local web server Feb 4, 2022
Copy link
Contributor

@KMiller-Grafana KMiller-Grafana left a comment

Choose a reason for hiding this comment

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

LGTM.

@jdbaldry jdbaldry merged commit 50ceeb7 into main Feb 8, 2022
@jdbaldry jdbaldry deleted the jdb/2022-02-fix-table-of-contents branch February 8, 2022 08:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants