Skip to content

Commit

Permalink
fix(mkdocs): structure according best practices
Browse files Browse the repository at this point in the history
This change structures mkdocs according to their [recommended file
layout][mkdocs-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][backstage-techdocs-ref].

[mkdocs-file-layout]: https://www.mkdocs.org/user-guide/writing-your-docs/#file-layout
[backstage-techdocs-ref]: https://backstage.io/docs/features/techdocs/how-to-guides/#how-to-understand-techdocs-ref-annotation-values
  • Loading branch information
zzehring committed May 9, 2024
1 parent a8254db commit b444738
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 2 deletions.
2 changes: 1 addition & 1 deletion catalog-info.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ metadata:
- title: Slack Channel
url: https://raintank-corp.slack.com/archives/C018SLDD5MW
annotations:
backstage.io/techdocs-ref: dir:./docs
backstage.io/techdocs-ref: dir:.
github.com/project-slug: grafana/grizzly
spec:
type: service
Expand Down
1 change: 0 additions & 1 deletion docs/mkdocs.yml → mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
site_name: 'Grizzly Internal Documentation'
repo_url: https://github.com/grafana/grizzly
edit_uri: edit/main/docs
docs_dir: .

theme:
name: material
Expand Down

0 comments on commit b444738

Please sign in to comment.