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 the getting started guide #536

Merged

Conversation

dagardner-nv
Copy link
Contributor

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

  • Includes changes from PRs Reorg docs #522 & Morpheus not "Morpheus SDK" #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

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 2 - In Progress labels Dec 10, 2022
@dagardner-nv dagardner-nv requested review from a team as code owners December 10, 2022 00:29
@dagardner-nv dagardner-nv changed the title David docs 23.01 getting started Restructure the getting started guide Dec 10, 2022
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.

This is a good first start. We will probably iterate in the future.

@dagardner-nv
Copy link
Contributor Author

@gpucibot merge

@ghost ghost merged commit f0df954 into nv-morpheus:branch-23.01 Dec 13, 2022
@dagardner-nv dagardner-nv deleted the david-docs-23.01-getting-started branch November 7, 2024 17:48
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