Skip to content

Commit

Permalink
Fix docs bug
Browse files Browse the repository at this point in the history
Signed-off-by: Aadhitya A <aadhitya864@gmail.com>
  • Loading branch information
alphaX86 committed Nov 22, 2023
1 parent 3c38c86 commit 2e37e32
Showing 1 changed file with 3 additions and 8 deletions.
11 changes: 3 additions & 8 deletions docs/pages/project/contributing/contributing-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,8 +165,7 @@ Example:```
mesheryctl system start

// To create a new context for in-cluster Kubernetes deployments and set the new context as your current-context
mesheryctl system context create k8s -p kubernetes -s
```,
mesheryctl system context create k8s -p kubernetes -s```,
Annotations: linkScreenshot,
...{% endcapture %}

Expand All @@ -186,8 +185,7 @@ Example:```
mesheryctl pattern apply -f [file | URL]

// deploy a saved pattern
mesheryctl pattern apply [pattern-name]
```,
mesheryctl pattern apply [pattern-name]```,
Annotations: linkDocPatternApply,
...
{% endcapture %}
Expand All @@ -207,10 +205,8 @@ Though the command page is generated automatically by the Cobra CLI library, the
`mesheryctl` uses Cobra CLI library and GitHub Actions to automate the generation of command documentation pages. On occasion, additional documentation beyond that included in the `mesheryctl` Golang files is ideal to capture and include in the CLI reference pages. Contributors are encouraged to add more usage examples, screenshots to any of the CLI reference pages. To protect any manually added content and ensure it remains intact after regeneration, create a separate Jekyll `include` file. Follow file naming scheme outlined below:

If your mesheryctl docs end like this, add the include tag at the end of the file. An example is given below
{% capture code_content %}Example:
## Options inherited from parent commands

{% capture code_content %}
<pre class='codeblock-pre'>
<div class='codeblock'>
--config string path to config file (default "/home/runner/.meshery/config.yaml")
Expand All @@ -222,7 +218,6 @@ If your mesheryctl docs end like this, add the include tag at the end of the fil

{% raw %}{% include permalink-of-file %}{% endraw %}
{% endcapture %}
{% include mesheryctl/code.html code=code_content %}


This format should reference an external file where your manual changes are stored. These files should be present at the folder path (`_includes/mesheryctl/`). Any content added using this method will not be altered during the documentation generation process, but instead will be included post-auto doc generation. When making new changes or additions, understand that these additional details are positioned at the end their given CLI reference page, so bear this in mind as you organize and present your additional command details.
Expand Down

0 comments on commit 2e37e32

Please sign in to comment.