grafana / grizzly

A utility for managing Jsonnet dashboards against the Grafana API
https://grafana.github.io/grizzly/
Apache License 2.0
514 stars 66 forks source link

fix(mkdocs): structure according best practices #442

Closed zzehring closed 4 months ago

zzehring commented 4 months ago

This change structures mkdocs according to their recommended file layout. This moves mkdocs.yml to the root of the project, alongside the docs/ directory.

Also, update the catalog-info.yml's backstage.io/techdocs-ref annotation to .. Backstage strongly recommends techdocs-ref annotation to be set to dir:. in almost all situations.

julienduchesne commented 4 months ago

Heh, exactly my PR: https://github.com/grafana/grizzly/pull/441

julienduchesne commented 4 months ago

Can you fix the refs in the workflow file like I did in here: https://github.com/grafana/grizzly/pull/441

zzehring commented 4 months ago

Can you fix the refs in the workflow file like I did in here: https://github.com/grafana/grizzly/pull/441

Oh yea good catch! Will do.