(DOCSP-7436): adding k8s-op-om-setting directive #331
Conversation
sphinxext/mongodb_conf.py
Outdated
| @@ -331,6 +331,13 @@ | |||
| 'prepend': True, | |||
| 'callable': False | |||
| }, | |||
| { | |||
| 'name': 'k8s-op-om-setting', | |||
There was a problem hiding this comment.
Hey @jwilliams-mongo , @jdestefano-mongo -- this is rather a mouthful of a name and tag. I think for usability, you all might want to shorten this.
.. _k8s-op-om-setting:: foobar
then to link :k8s-op-om-setting:`foobar` . which I can see as inviting typos and forgetting what the setting name was.
Also, for some references, you will have to prepend the tag so that people will have to do :k8s-op-om-setting:`~k8s-op-om-setting.foobar`
There was a problem hiding this comment.
good point @kay-kim. made these shorter. look good to you?
sphinxext/mongodb_conf.py
Outdated
| @@ -332,8 +332,8 @@ | |||
| 'callable': False | |||
| }, | |||
| { | |||
| 'name': 'k8s-op-om-setting', | |||
| 'tag': 'k8s-op-om-setting', | |||
| 'name': 'omk8sop', | |||
There was a problem hiding this comment.
How about
- opsmgrkube or
- opsmgrk8s or
The reason I kind of prefer kube is so that when typing you don't have to reach for the number. but I don't actually care as I won't need to use this settings, but definitely think about typing/usability.
|
merged! |
JIRA
adding new directive to work around issue with reusing :settings: with the same name on multiple pages