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.

Sign up for GitHub

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

Jump to bottom

Add documentation checks to CI #1821

Merged
merged 109 commits into from
Aug 1, 2024
Merged

Add documentation checks to CI #1821

merged 109 commits into from
Aug 1, 2024

Conversation

dagardner-nv
Copy link
Contributor

@dagardner-nv dagardner-nv commented Jul 25, 2024 •
edited
Loading

Description

  • Add vale as a documentation linter to CI
  • Add custom vocabulary (ci/vale/styles/config/vocabularies/morpheus/accept.txt).
  • Add sphinx's linkcheck to the documentation builds
  • Fix spelling & grammar errors found in existing documentation

Closes #545

By Submitting this PR I confirm:

  • I am familiar with the Contributing Guidelines.
  • When the PR is ready for review, new or existing tests cover these changes.
  • When the PR is ready for review, the documentation is up to date with these changes.

@dagardner-nv
Add value to conda env
33163e0
@dagardner-nv
Add style packages, first pass at a .vale.ini, since running 'vale sy…
7da7d51 
…nc' only takes two seconds, I opted against checking the styles into the repo instead directing them towards '.tmp/vale-styles'
@dagardner-nv
WIP
2db7842
@dagardner-nv
Move styles to ci/vale/styles, set the alert level to warning, define…
50009a5 
… a vocab.
@dagardner-nv
Remove bad symlink:
afab4ba
@dagardner-nv
Don't need the 3rd party styles checked into the repo if they exist i…
8c228fa 
…n the conda env
@dagardner-nv
Use DataFrames not dataframes
55be479
@dagardner-nv
Add the following words: boolean, Conda, cryptocurrency, dev, repo an…
8875ad4 
…d XGBoost
@dagardner-nv
For now only report errors, disable the contractions rule
48a82b7
@dagardner-nv
Remove the 'Setup Env Variable' section, vale flagged 'Env' as mis-sp…
669a7c1 
…elled, MORPHEUS_ROOT variable is not needed for this example
@dagardner-nv
Fix mis-spelling, suround field-names with back-ticks
3845b60
@dagardner-nv
Capitalize PCAP as its an acronym
a02a803
@dagardner-nv
Replace DGX's with DGX systems
88eea1f
@dagardner-nv
Replace ambigous usage of 'dev container'
332eccb
@dagardner-nv
Add Milvus
9a84bff
@dagardner-nv
Enclose vdb_upload in backticks
024e48a
@dagardner-nv
Hugging Face is the correct name not Huggingface
0f39336
@dagardner-nv
Add chatbot, PDF, and uploader
214ee3d
@dagardner-nv
LangChain not langchain
b847d3f
@dagardner-nv
LangChain not langchain
5e4057e
@dagardner-nv
Add LLM, consolidate plural and singular GPU and NIM entries
011e330
@dagardner-nv
LLMs not LLM's, fix mis-spelling for bootstrap
c5c211b
@dagardner-nv
Surround code names in backticks, fix title of completion pipeline, u…
681a146 
…se correct casing for NeMo
@dagardner-nv
First pass at a CI script for running vale
915ded0
@dagardner-nv
Add cmake
9c7ed08
@dagardner-nv
Re-enable Microsoft.Contractions at the suggestion level, lower write…
62ab29f 
…-good.ThereIs to suggestion
@dagardner-nv
environment not env, use proper casing of CMake
e84926e
@dagardner-nv
Add NIC and PCIe
8a04b0a
@dagardner-nv
Fix casing and spelling
18bd44b
@dagardner-nv
Merge branch 'branch-24.10' of github.com:nv-morpheus/Morpheus into d…
a30719a 
…avid-docs-lint-545
@dagardner-nv dagardner-nv added doc Improvements or additions to documentation and removed DO NOT MERGE PR should not be merged; see PR for details labels Jul 26, 2024
mikemckiernan
mikemckiernan reviewed Jul 26, 2024
View reviewed changes
Copy link

@mikemckiernan mikemckiernan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I make a quick spot check of a few files. I pointed out changes that I'd make, but I don't think we have formal edit policy.

ci/vale/styles/config/vocabularies/morpheus/accept.txt Outdated Show resolved Hide resolved
ci/vale/styles/config/vocabularies/morpheus/accept.txt Outdated Show resolved Hide resolved
ci/vale/styles/config/vocabularies/morpheus/accept.txt Show resolved Hide resolved
ci/vale/styles/config/vocabularies/morpheus/accept.txt Outdated Show resolved Hide resolved
ci/vale/styles/config/vocabularies/morpheus/accept.txt Show resolved Hide resolved
docs/source/developer_guide/architecture.md Show resolved Hide resolved
docs/source/developer_guide/architecture.md Outdated Show resolved Hide resolved
docs/source/developer_guide/architecture.md Outdated Show resolved Hide resolved
docs/source/developer_guide/architecture.md Outdated Show resolved Hide resolved
docs/source/developer_guide/guides/10_modular_pipeline_digital_fingerprinting.md Outdated Show resolved Hide resolved
@dagardner-nv dagardner-nv marked this pull request as ready for review July 26, 2024 17:51
mdemoret-nv
mdemoret-nv approved these changes Jul 31, 2024
View reviewed changes
.vale.ini Outdated Show resolved Hide resolved
ci/scripts/documentation_checks.sh Outdated Show resolved Hide resolved
ci/vale/styles/config/vocabularies/morpheus/accept.txt Outdated Show resolved Hide resolved
@dagardner-nv dagardner-nv requested a review from a team as a code owner July 31, 2024 22:17
@dagardner-nv
Copy link
Contributor Author

/merge

@dagardner-nv
Copy link
Contributor Author

/merge

1 similar comment
@dagardner-nv
Copy link
Contributor Author

/merge

@rapids-bot rapids-bot bot merged commit 9fae209 into nv-morpheus:branch-24.10 Aug 1, 2024
12 checks passed
@dagardner-nv dagardner-nv deleted the david-docs-lint-545 branch August 1, 2024 21:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mikemckiernan mikemckiernan mikemckiernan left review comments

@mdemoret-nv mdemoret-nv mdemoret-nv approved these changes

@hsin-c hsin-c hsin-c approved these changes

Assignees

@dagardner-nv dagardner-nv

Labels
doc Improvements or additions to documentation non-breaking Non-breaking change
Projects
Morpheus Boards
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[DOC]: Investigate using vale.sh as part of our CI
4 participants
@dagardner-nv @mikemckiernan @mdemoret-nv @hsin-c