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

Reorg docs #522

Merged
38 commits merged into from
Dec 13, 2022
Merged

Reorg docs #522

38 commits merged into from
Dec 13, 2022

Conversation

dagardner-nv
Copy link
Contributor

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

  • Move most of the content of README.md to docs/source/getting_started.md
  • README.md now directs readers to other sources of documentation.
  • CONTRIBUTING.md now included in doc builds
  • guides.rst is now a markdown file to ensure its viewable in github
  • Titles in developer guides updated to remove the prefixed numbers (hold-over from when these were all in one document)
  • code of conduct & license appear in table of contents
  • docs/source/index.rst contains links to getting started docs
  • Known issues file refers to open github issues.
  • Remove smart quote chars
  • Fix misc parsing errors/warnings
  • Myst doesn't like 'yml' as a syntax alias for 'yaml'
  • Fix links to images for developer examples

relates to issue #495

@dagardner-nv dagardner-nv added non-breaking Non-breaking change doc Improvements or additions to documentation DO NOT MERGE PR should not be merged; see PR for details 2 - In Progress labels Dec 7, 2022
@dagardner-nv dagardner-nv requested review from a team as code owners December 7, 2022 20:30
@dagardner-nv dagardner-nv removed the DO NOT MERGE PR should not be merged; see PR for details label Dec 7, 2022
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

Copy link
Contributor

@mdemoret-nv mdemoret-nv left a comment

Choose a reason for hiding this comment

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

LGTM

@dagardner-nv
Copy link
Contributor Author

@gpucibot merge

@ghost ghost merged commit 01e51c0 into nv-morpheus:branch-23.01 Dec 13, 2022
ghost pushed a commit that referenced this pull request Dec 13, 2022
* Morpheus is an SDK, "Morpheus SDK" and "Morpheus SDK Client" are redundant
* We do have a helm chart named `morpheus-sdk-client`, so references to the helm chart retain the "sdk client".
* Update elevator pitch paragraph in `docs/source/index.rst` to match that of the `README.md`
* Add license comment to `README.md` and `CONTRIBUTING.md` files
* Includes changes from PR #522

relates to issue #495

Authors:
  - David Gardner (https://github.com/dagardner-nv)

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

URL: #534
ghost pushed a commit that referenced this pull request Dec 13, 2022
* Includes changes from PRs #522 & #534
* Moves `docs/source/basics/examples.rst` into `examples/basic_usage` and reformat as markdown. This avoids the issue of having two "examples" in the table of contents.
* Update remaining references to the quickstart guide with "cloud deployment".
* Create Parallel `index.rst` for the developer guides and examples, as markdown doesn't have the equivalent of the `toctree` macro.
* Restructure `docs/source/getting_started.md` making it clear which steps are and are not needed when using pre-built containers.
* Highlight the examples from top-level docs

relates to issue #495

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

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

URL: #536
This pull request was closed.
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.

3 participants