Skip to content
This repository has been archived by the owner on Mar 5, 2024. It is now read-only.

(DOCSP-7436): adding k8s-op-om-setting directive #331

Merged
merged 3 commits into from
Oct 23, 2019
Merged

(DOCSP-7436): adding k8s-op-om-setting directive #331

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2d8f3cb
(DOCSP-7436): adding k8s-op-om-setting directive
jwilliams-mongo Oct 23, 2019
2ca8fc7
(DOCSP-7436): shortened directive name and tag based on feedback
jwilliams-mongo Oct 23, 2019
1b166b0
(DOCSP-7436): changing dirctive name to make it more usable
jwilliams-mongo Oct 23, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions sphinxext/mongodb_conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,6 +331,13 @@
'prepend': True,
'callable': False
},
{
'name': 'k8s-op-om-setting',
Copy link
Contributor

@kay-kim kay-kim Oct 23, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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`

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good point @kay-kim. made these shorter. look good to you?

'tag': 'k8s-op-om-setting',
'description': 'Kubernetes Operator Ops Manager Resource Setting',
'prepend': True,
'callable': False
}
]

## If prepend: True, you can have a page title that match the directive. For example, an operator X in a page with title X. Otherwise, you can't have in page with same title and you'll get iddup as the reference.
Expand Down