[meta] Supported Directives

[Mpdreamz]

This meta issue tracks our feature completeness as measured against Myst Reference on directives

myst

• [x] #3
• [x] #4
• [x] #5
• [x] #6
• [ ] #7
• [x] #8
• [x] #9
• [x] #10
• [ ] #11
• [x] #12
• [ ] #13
• [x] #14
• [x] #15
• [x] #16
• [x] #17
• [x] #18
• [ ] #19
• [x] #20
• [x] #22
• [ ] #23
• [x] #24
• [x] #25
• [x] #26
• [x] #27
• [x] #28
• [ ] #29
• [x] #30
• [x] #31
• [x] #37

sphinx

As well as several directives we support from Sphinx: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html

• [x] #32
• [x] #33
• [x] #34
• [x] #35
• [x] #36

[bmorelli25]

@KOTungseth took an initial stab at this. Here's the result of our conversation.

Not needed

• https://github.com/elastic/docs-builder/issues/5
• https://github.com/elastic/docs-builder/issues/6
• https://github.com/elastic/docs-builder/issues/9 -- focus on only one format for creating tables
• https://github.com/elastic/docs-builder/issues/14
• https://github.com/elastic/docs-builder/issues/17
• https://github.com/elastic/docs-builder/issues/20
• https://github.com/elastic/docs-builder/issues/22 -- what is this?
• https://github.com/elastic/docs-builder/issues/24 -- accomplished with admonitions
• https://github.com/elastic/docs-builder/issues/25
• https://github.com/elastic/docs-builder/issues/26
• https://github.com/elastic/docs-builder/issues/30
• https://github.com/elastic/docs-builder/issues/31
• https://github.com/elastic/docs-builder/issues/32 -- moving away from this to YAML

Not needed for 9.0

• https://github.com/elastic/docs-builder/issues/4
• https://github.com/elastic/docs-builder/issues/8

Needed for 9.0

Note: We still need to scope out arguments and implementation details for these issues.

• https://github.com/elastic/docs-builder/issues/7
• https://github.com/elastic/docs-builder/issues/3
  • We want to be prescriptive about the aliases we allow. The current list of 10+ is too many.
  • Note, Warning, Important, and Tip
  • This also needs to be added to the style guide
• https://github.com/elastic/docs-builder/issues/15
• https://github.com/elastic/docs-builder/issues/23
  • a lot of previous discussions on table capabilities to be revisited
  • do we actually need complex capabilities?
  • could go simple for v9 and more complex after?
• https://github.com/elastic/docs-builder/issues/10
• https://github.com/elastic/docs-builder/issues/13
• https://github.com/elastic/docs-builder/issues/27 + https://github.com/elastic/docs-builder/issues/28
  • Note for @KOTungseth: We need to make sure this meets SEO standards
• https://github.com/elastic/docs-builder/issues/33, https://github.com/elastic/docs-builder/issues/34, https://github.com/elastic/docs-builder/issues/35, https://github.com/elastic/docs-builder/issues/36
  • Need to discuss more. We need something like this, but is this the right approach?
  • What about badges?
• Definition lists. No open issue for this functionality yet.
  • Context: docsmobile/issues/413

Further discussion required

• https://github.com/elastic/docs-builder/issues/11 vs https://github.com/elastic/docs-builder/issues/16
• https://github.com/elastic/docs-builder/issues/19 vs https://github.com/elastic/docs-builder/issues/29: requires further discussion with @lcawl about ML implications
• Linking: this could be handled either with a directive or with substitution. Pros and Cons to either approach

[Mpdreamz]

mermaid, card, grid, aside are already implemented so will leave them in for now @KOTungseth @bmorelli25 under the assumption they were left out for implementation time sake?