-
Notifications
You must be signed in to change notification settings - Fork 537
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
Docs: Add local preview for documentation #1041
Conversation
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.
We already have a docs
target in the top-level Makefile included from docs.mk
.
For consistency with other repositories, I suppose I should move that Makefile into the docs/
directory.
Would you be able to make the changes in docs.mk
or explain what additional step we need to take to make sure that the table of contents works as expected; is it the creation of the _index.md
, is it the use of make server
, or both?
The extra command is temporary as there is no |
Gotcha! Just confirmed locally that this works. Would you like me to incorporate these changes into |
I am just now realizing there is a |
Yeah I think it's worth moving it so other can find it easier. We can also include it in the top-level Makefile too without any fuss. I'll open up a PR, two ticks. |
Closing as #1043 resolved this. |
What this PR does:
Adds a local preview for the docs.
/bin/bash -c "touch content/docs/mimir/_index.md && make server"
can be removed once the website team updates the docker image.Which issue(s) this PR fixes:
Fixes https://github.com/grafana/mimir-squad/issues/523