Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PD-243 update cli introductory article content #1881

Merged
merged 14 commits into from
May 3, 2023

Conversation

micjohnson777
Copy link
Contributor

The SCALECLIIntro.md article is still a work in progress with updates planned each time a new namespace is documented and we learn about the syntax and use of arguments, options, brackets and delimiters to produce working commands.

This is a starting point.

Additional drop-in snippets are planned and will be added as more namespaces are documented.

This is ready for review and feedback, and if approved, merging.

Thanks for contributing to TrueNAS documentation! By opening a Pull Request, you're acknowledging that your changes will be distributed under the Creative Commons 4.0 license.

This commit moves content from the /SCALE/SCALECLIReference/_index.md file into a new SCALECLIIntro.md file
This commit updates the table of namespaces to include the child namespaces.
this commit creates an introduction snippet to use in the main index file and the new SCALECLIIntro.md article.
This commit updates the content and changes headings in the new SCALECLIIntro.md article. It adds two new snippets to use in other article content.
This commit makes final changes to the snippet and introduction article content.

Updates are planned to the command syntax as more information is determined on proper syntax and structure while documenting individual namespaces.
@micjohnson777 micjohnson777 requested a review from a team as a code owner April 28, 2023 16:22
micjohnson777 and others added 8 commits April 28, 2023 13:17
This commit adds information on case sensitivity to the SCALECLIIntro.md article and changes the weight to follow the index file.
This commit adds  draft: true to the front matter.
this commit updates code style in the Basic Commands table to show commands in bold as well as code block.
Fixes the hint shortcode, and changes the front matter to draft:false
This commit removes the last bold code block tags.
Reincorporate the intro article into the _index file (landing page) for the guide.
Minor spelling and wording cleanup
Minor whitespace cleanup.
@Mrt134 Mrt134 changed the title Pd 243 update cli introductory article content PD-243 update cli introductory article content May 3, 2023
@Mrt134 Mrt134 added the Review (TM) A technical writer is reviewing the PR. label May 3, 2023
@Mrt134 Mrt134 merged commit 0bc1f02 into master May 3, 2023
3 checks passed
@Mrt134 Mrt134 deleted the PD-243-Update-CLI-Introductory-Article-Content branch May 3, 2023 19:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Review (TM) A technical writer is reviewing the PR.
Projects
None yet
2 participants