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

Restructure table of contents and other misc updates #538

Conversation

dagardner-nv
Copy link
Contributor

@dagardner-nv dagardner-nv commented Dec 13, 2022

  • Includes changes from PRs Reorg docs #522, Morpheus not "Morpheus SDK" #534 & Restructure the getting started guide #536
  • Table of contents now includes five main sections:
    1. Using Morpheus
    2. Modifying Morpheus
    3. Deploying Morpheus
    4. API
    5. Extra Information
  • Document versioning of docker releases
  • Add tidbit about assumption that the Docker linux post install steps have been performed.
  • Sphinx index contains banner image
  • Banner image moved to docs/source/img and migrated to LFS
  • CONTRIBUTING.md is now a stub file directing readers to docs/source/developer_guide/contributing.md
  • Fix dependency diagram in developer guid

fixes #495

bsuryadevara and others added 30 commits October 11, 2022 16:02
…rpreter prompt to prefix the code examples in order to generate propperly
@dagardner-nv dagardner-nv added non-breaking Non-breaking change doc Improvements or additions to documentation 3 - Ready for Review labels Dec 13, 2022
@dagardner-nv dagardner-nv requested review from a team as code owners December 13, 2022 00:03
Copy link
Contributor

@drobison00 drobison00 left a comment

Choose a reason for hiding this comment

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

LGTM for the most part, found two small issues.

docs/source/index.rst Outdated Show resolved Hide resolved
dagardner-nv and others added 2 commits December 13, 2022 15:50
Co-authored-by: Devin Robison <drobison00@users.noreply.github.com>
ghost pushed a commit that referenced this pull request Dec 16, 2022
* Includes changes from PR #538 
* Fixes casing for proper nouns (NVIDIA, Docker, Triton, Python, Conda) when not referring to a command
* Document `StreamPair` (docstrings for globals need to appear after the definition)
* Other fixes suggested by Zenobia
* Brings grade up from an A to A+
* Fixes CSS theme issue #543 
* Various fixes to the `getting_started.md` doc fixes #539
* Fixes issue with the `docker/run_container_*.sh` scripts for users who have the Nvidia Container Toolkit installed but does not have nvidia set as the default runtime
* Documents launching a pre-built Morpheus container
* Fix errant entry in docstring for `AppShieldSource` which was showing up in the command line help
* Documentation work-around for #475
* Fix a few remaining references to 'srf'

Authors:
  - David Gardner (https://github.com/dagardner-nv)
  - https://github.com/bsuryadev
  - Bhargav Suryadevara (https://github.com/bsuryadevara)

Approvers:
  - Christopher Harris (https://github.com/cwharris)
  - Michael Demoret (https://github.com/mdemoret-nv)

URL: #547
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation non-breaking Non-breaking change
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

[DOC]: Expand and Refactor Morpheus Documentation
3 participants