grafana / grafana/shared-workflows

[techdocs] Use `gh-admonitions` plugin everywhere

Open
#657 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
26
Forks
49
Avg merge
1d 6h
Merged PRs (30d)
36

Description

The `gh-admonitions` plugin was added to the shared workflow in https://github.com/grafana/shared-workflows/commit/7973f46778ca0748974cb2c38670300b6efc57d0

It's not ideal that individual repositories have to add this to their config. This ought to be something that works out ouf the box.

The `@techdocs/cli` script has a flag:

```
Usage: techdocs-cli generate|build [options]

Generate TechDocs documentation site using MkDocs.

Options:
...
--defaultPlugin [defaultPlugins...] Plugins which should be added automatically to the mkdocs.yaml file (default: [])
...
```

which might be able to be used for this purpose, if it works like it sounds.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.