Skip to content

Commit 6c1fde9

Browse files
committed
Copy OS label advice from chat.
1 parent 7b8d510 commit 6c1fde9

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,33 @@ to via intersphinx.
7676
We use a few custom Sphinx extensions, for details see
7777
[cylc-sphinx-extensions](https://cylc.github.io/cylc-sphinx-extensions/).
7878

79+
80+
### Label Guidance
81+
82+
Some things to bear in mind when defining labels in cylc-doc e.g. `.. _my-label`:
83+
84+
**Namespace your labels**
85+
86+
* E.g. `user-guide.something` rather than `something`.
87+
* (Look for existing naming patterns before defining a new one).
88+
89+
**Labels are imported from other projects (e.g. Rose, Jupyter Server, etc)**
90+
* So avoid excessively vague labels where possible.
91+
* And only add labels where they are needed (labels are only for references,
92+
they don't serve any other purpose so adding excess ones doesn't benefit
93+
other things).
94+
95+
**References resolve attach headers**
96+
* So if a section has the heading `Running Schedulers`, then a good label
97+
might be `user-guide.running-schedulers` rather than `scheduler runtime`
98+
as this gives the person using the label a better idea of how it is
99+
likely to be presented.
100+
101+
**Labels are forever**
102+
* Other projects (e.g. metomi-docs) might use these labels!
103+
104+
105+
79106
## Development
80107

81108
[![test](https://github.com/cylc/cylc-doc/workflows/test/badge.svg?branch=master&event=push)](https://github.com/cylc/cylc-doc/actions?query=workflow%3Atest)

0 commit comments

Comments
 (0)