Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Documentation is generated in Markdown, associated with each repository, moved to open-horizon.github.io repo when merged, and the site is generated in Jekyll with keywords abstracted out and inserted at page generation time.

Structure


Directives

Manual HTML element IDs

IDs are currently assigned using this syntax, which throws an acorn parsing error:

Code Block
# Accessing management hub logs
{: #accessing_logs}

The proposed solution is to remove the colon and space from the tag and move it up to the previous line separated from the title by a space:

Code Block
# Accessing management hub logs {#accessing_logs}

Code blocks with CSS className for styling

Code blocks are currently written using this pattern:

Code Block
```bash
oc get pods --namespace kube-system | grep ibm-edge
```
{: codeblock}

The hanging colon directive at the end is causing an acorn parsing error.  Proposed solution is to remove the trailing directive and edit site configuration to add className to all code blocks if still needed:

Code Block
```bash
oc get pods --namespace kube-system | grep ibm-edge
```


Navigation


Keywords


I18N


Automation/Generation

...