search

grafana / explore-logs

Repo for the Loki log exploration app
GNU Affero General Public License v3.0
236 stars 7 forks source link

Add make docs procedure #472

Closed jdbaldry closed 4 days ago

jdbaldry commented 2 weeks ago

Add the tooling for rendering a local preview of the documentation and a procedure to keep it up to date.

For more information, refer to https://grafana.com/docs/writers-toolkit/review/.

Signed-off-by: Jack Baldry jack.baldry@grafana.com

jdbaldry commented 2 weeks ago

For publishing "next" content, we first need to merge https://github.com/grafana/website/pull/20393 to prevent publishing prematurely and then I an install something like https://github.com/grafana/grafana/blob/main/.github/workflows/publish-technical-documentation-next.yml to do the publishing.

Do we have an issue somewhere that explains where we want the docs to show up in the website?

JStickler commented 1 week ago

Do we have an issue somewhere that explains where we want the docs to show up in the website?

We're having an information architecture meeting on Tuesday to figure that out.

jdbaldry commented 4 days ago

https://github.com/grafana/explore-logs/pull/494/ was merged that will sync documentation