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

Docs: Add local preview for documentation #1041

Closed
wants to merge 2 commits into from

Conversation

robbymilo
Copy link
Contributor

@robbymilo robbymilo commented Feb 4, 2022

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

Copy link
Member

@jdbaldry jdbaldry left a 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?

@robbymilo
Copy link
Contributor Author

Would you be able to ... 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 _index.md for mimir in the docker image, which the menu template relies on. We need make server here as the default command is now overridden. The website team will update the image next week, and then this can be removed.

@jdbaldry
Copy link
Member

jdbaldry commented Feb 4, 2022

Gotcha! Just confirmed locally that this works. Would you like me to incorporate these changes into docs.mk (I can then also move it to the /docs subdirectory too)?

@robbymilo
Copy link
Contributor Author

I am just now realizing there is a docs.mk. In my opinion we should be consistent company-wide, as this is the first repo I've seen where you don't cd into the docs directory. I'm not the end user here, so I'll defer to the mimir or docs team.

@jdbaldry
Copy link
Member

jdbaldry commented Feb 4, 2022

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.

@osg-grafana osg-grafana added the type/docs Improvements or additions to documentation label Feb 7, 2022
@osg-grafana osg-grafana changed the title add local preview for docs Docs: Add local preview for documentation Feb 7, 2022
@osg-grafana osg-grafana self-requested a review February 7, 2022 08:47
@jdbaldry
Copy link
Member

jdbaldry commented Feb 8, 2022

Closing as #1043 resolved this.

@jdbaldry jdbaldry closed this Feb 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants