The doc-review command spell checks your content and reviews release notes.
Checks the spelling in Markdown and YAML files and compares release note files to our release note standards.
Argument | Description |
---|---|
-i, --input | Path to the file to check. |
-g, --use-git | Uses git to identify the relevant changed files. This option is used default if |
--prev-ver | The branch against which changes are detected if |
--no-camel-case | Whether to run spell check on words in CamelCase. |
--known-words | The path to a file containing a list of known words. |
--always-true | Whether the command should fail if misspelled words are found. |
--expand-dictionary | Whether to expand the base dictionary to include more words. If this option is used, it will download brown and webtext corpora from nltk package. |
--templates | Whether to print release notes templates. |
-rn, --release-notes | Runs only on release notes files. |
-clt, --console-log-threshold | Minimum logging threshold for the console logger. Default value is |
-flt, --file-log-threshold | Minimum logging threshold for the file logger. Default value is |
-lp, --log-file-path | The path to the log file. Default path is |
-xs, --xsoar-only | Runs only on files from Cortex XSOAR-supported packs. |
-pkw/-spkw, --use-packs-known-words/--skip-packs-known-words | Finds and loads the |
demisto-sdk doc-review -i ~/Integrations/integration-MyInt.yml --no-camel-case
Checks the spelling in the given integration file and treats camel case words as misspelled words.
demisto-sdk doc-review -i Packs/MyPack/Scripts --expand-dictionary
Spell checks all eligible files under the
Packs/MyPack/Scripts
directory. Also downloads and uses the brown and webtext corpora from the nltk package.demisto-sdk doc-review -i ~/Integrations/MyIntegration/README.md --known-words ~/Integrations/additional_words.txt
Spell checks the given
README.md
file as well as expands the known words with the word list found in theadditional_words.txt
file.demisto-sdk doc-review --templates
Prints the documentation template examples.
demisto-sdk doc-review --prev-ver myRemote/master -rn
Performs a documentation review on all the release notes that were changed (added or modified) when compared to 'myRemote/master' using git.