search

IBM / marked-it-cli

marked-it-cli
MIT License
5 stars 15 forks source link

Content reuse: JSON toc linking support #6

Open sefuhrer opened 5 years ago

sefuhrer commented 5 years ago

We need a better way to share content that lives in separate repos via links in TOC.

  1. We want to be able to cross-link to content
  2. We want to be able to reuse or pull content into a toc

Example of what MS does: https://dotnet.github.io/docfx/tutorial/intro_toc.html#link-to-another-toc-file

Use case:

  1. We have many cli plugins at /docs root today: https://dev.console.test.cloud.ibm.com/docs/container-registry-cli-plugin/container-registry-cli.html
  2. We want to be able to pull the plugin content into the toc and point to them from /cli At this link :https://dev.console.test.cloud.ibm.com/docs/cli/plugins/auto-scaling/index.html#autoscalingcli, auto-scaling is building today inside /cli (content is physically nested) so of course toc works, its just nested, but pointing off to container-registry-cli-plugin which lives at /docs/ root in its own folder, does not.

https://github.ibm.com/Bluemix-Docs/cli/blob/staging/toc Right now using relative path will not work, and toc link for xml has no correlative to json:
[Container Registry CLI plug-in](../container-registry-cli-plugin/container-registry-cli.html)