grafana / explore-logs

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

Add workflow that syncs documentation to the website repository on pushes to main #494

Closed jdbaldry closed 3 months ago

jdbaldry commented 3 months ago

We can test and evaluate the Continuous Delivery of documentation to the website repository without publishing it on the website thanks to https://github.com/grafana/website/pull/20393/files which tells Hugo not to render or list any pages under content/docs/explore-logs/.

We can also put in place a similar workflow for publishing versioned releases of documentation after we decide on how those are going to be maintained. grafana/grafana uses long-lived version branches for each version and documentation is synced from those branches. grafana/k6-docs doesn't need to version documentation alongside the code (because it's a separate repository) and maintains all of its documentation in the main branch.