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

Reorganize new docs 'guides' section #26019

Draft
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

neverett
Copy link
Contributor

Summary & Motivation

I'm a fair way through auditing old and new docs content, and have started working on figuring out how to plug the remaining gaps in new docs. To that end, I reorganized the /guides section of new docs to make it easier to move old content to the new site.

Big changes I made in this PR:

  • Moved docs from the concepts directory into guides directories (automate, build, deploy, monitor, test). The guides docs already contain a lot of conceptual content; the distinction between the two sections seemed fairly arbitrary and not helpful for readers.
  • Added a top-level glossary page that can serve as a quick reference to documentation about key concepts, so we don't lose that aspect of having a separate concepts section.
  • Created a directory structure that mirrors the URL structure. It's a bit old-fashioned, but this helps readers orient themselves in the docs, and helps contributors reason about where to put stuff.

How I Tested These Changes

Local build.

Changelog

Insert changelog entry or delete this section.

Signed-off-by: nikki everett <nikki@dagsterlabs.com>
@neverett neverett added the area:docs-revamp Related to the revamp of the docs label Nov 19, 2024
@neverett neverett self-assigned this Nov 19, 2024
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
:::info
To deploy to Dagster+, see the [Dagster+ getting started](/dagster-plus/getting-started) guide.

To migrate from self-hosted to Dagster+, see TK.
Copy link

Choose a reason for hiding this comment

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

This appears to be a placeholder (TK) that needs to be replaced with a link to the migration documentation. Consider updating this before merging to ensure users can find the correct migration guide.

Spotted by Graphite Reviewer

Is this helpful? React 👍 or 👎 to let us know.

Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:docs-revamp Related to the revamp of the docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant