mimir
mimir copied to clipboard
Docs: Change task topic titles from gerunds to imperatives
Change all task topics to (imperative) verb + object instead of using gerunds.
General approach:
- Add an alias that is self-referencing to all files.
- Commit the changes.
- Run
doc-validatorlocally; leave global link checking for later. - Commit the changes.
- Move a directory of files from -ing ending to imperative.
- Rerun
doc-validatorlocally on that directory; leave global link checking for later. - Fix any broken links with
mv-manager. - Rerun
doc-validatorfrom.../doc/sourcesin themimirrepo. - Repeat as needed.
- Commit the changes.
This involves link checking and alias changes.
Moving to 2.3 per conversation with @dimitarvdimitrov, because these changes are forward-facing changes and it reduces the need to cherry pick for 2.2.
Per @pracucci, the paths that are now absolute need to be relative.
Increasing estimate of complexity of this issue.
Increasing estimate of complexity of this issue.
No. It's not a requirement. Aliases can both be absolute or relative (both are supported). There are pros and cons of both. The reason why I opened https://github.com/grafana/mimir/pull/2396 is because in https://github.com/grafana/mimir/pull/2351 the relative paths were rewritten adding a / in front of them (so making them absolute, but without changing them to be real absolute paths).
@KMiller-Grafana, here is an issue that might cause problems with links breaking. @gguillotte-grafana is investigating how we can get visibility about which links are broken where across all Grafana Labs documentation. cc @knylander-grafana and @Eve832
@pracucci is correct. The relrefs will still work either way, but it's not a good habit. I think if we're linking across repos, we can either use ref instead of relref or absolute URLs.
@colega, added you as assignee because you volunteered. :)