Reorganize beta docs (pt 1) #26019
Merged
Reorganize beta docs (pt 1) #26019
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
cmpadden
approved these changes
Dec 3, 2024
## Summary & Motivation ## How I Tested These Changes ## Changelog > Insert changelog entry or delete this section.
Merge this PR, then merge #26019. ## Summary & Motivation Reorganizes docs in /dagster-plus to make it easier to port content from old docs. See #26019 for a more detailed description of the motivation -- many of the changes here are similar to changes in that PR. ## How I Tested These Changes Tested locally. ## Changelog > Insert changelog entry or delete this section. --------- Signed-off-by: nikki everett <[email protected]> Co-authored-by: colton <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
neverett
changed the title
Signed-off-by: nikki everett <[email protected]>
|
@dehume tagging you in here so you have a sense of what's being worked on in beta docs -- this PR corresponds to this internal Linear issue. |
cmpadden
added a commit
that referenced
this pull request
Dec 5, 2024
**NOTE:** Merge #26067 before merging this PR. ## 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` subdirectories (`automate`, `build`, `deploy`, `monitor`, `test`). The `guides` docs already contain a lot of conceptual content; the distinction between `concepts` and `guides` 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. (This is currently an unlisted draft page that will be finished after more content has been moved over.) * Updated information architecture: * Moved docs into a directory structure that mirrors the information architecture of the website/URL structure to make it easier for readers to orient themselves in the docs and for contributors to reason about where to put stuff. * Added index pages to docs subsections so support engineerins, SEs, and others can send users and customers links to logical chunks of information. * Updated `sidebars.ts` to use autogenerated navigation whenever possible. This will hopefully make contributing to docs a little easier -- if someone adds a new page to a section, they don't need to go into `sidebars.ts` and manually add the page name to its section to make it visible. (Entire new sections do need to be added manually, though.) * Used `sidebar_position` in the front matter to organize the position of docs in the sidebar. Index pages use multiples of 10, while pages use multiples of 100. This give us a bit of space between sections and pages to add content as needed. ## How I Tested These Changes Local build. ## Changelog Updated beta docs directory structure, added index pages to subsections, updated page positioning via sidebars.ts and sidebar_position in page front matter, removed references section and moved YAML reference docs to guides/deploy. --------- Signed-off-by: nikki everett <[email protected]> Co-authored-by: colton <[email protected]>
pskinnerthyme
pushed a commit
to pskinnerthyme/dagster
that referenced
this pull request
Dec 16, 2024
**NOTE:** Merge dagster-io#26067 before merging this PR. ## 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` subdirectories (`automate`, `build`, `deploy`, `monitor`, `test`). The `guides` docs already contain a lot of conceptual content; the distinction between `concepts` and `guides` 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. (This is currently an unlisted draft page that will be finished after more content has been moved over.) * Updated information architecture: * Moved docs into a directory structure that mirrors the information architecture of the website/URL structure to make it easier for readers to orient themselves in the docs and for contributors to reason about where to put stuff. * Added index pages to docs subsections so support engineerins, SEs, and others can send users and customers links to logical chunks of information. * Updated `sidebars.ts` to use autogenerated navigation whenever possible. This will hopefully make contributing to docs a little easier -- if someone adds a new page to a section, they don't need to go into `sidebars.ts` and manually add the page name to its section to make it visible. (Entire new sections do need to be added manually, though.) * Used `sidebar_position` in the front matter to organize the position of docs in the sidebar. Index pages use multiples of 10, while pages use multiples of 100. This give us a bit of space between sections and pages to add content as needed. ## How I Tested These Changes Local build. ## Changelog Updated beta docs directory structure, added index pages to subsections, updated page positioning via sidebars.ts and sidebar_position in page front matter, removed references section and moved YAML reference docs to guides/deploy. --------- Signed-off-by: nikki everett <[email protected]> Co-authored-by: colton <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
NOTE: Merge #26067 before merging this PR.
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:
conceptsdirectory intoguidessubdirectories (automate,build,deploy,monitor,test). Theguidesdocs already contain a lot of conceptual content; the distinction betweenconceptsandguidesseemed fairly arbitrary and not helpful for readers.sidebars.tsto use autogenerated navigation whenever possible. This will hopefully make contributing to docs a little easier -- if someone adds a new page to a section, they don't need to go intosidebars.tsand manually add the page name to its section to make it visible. (Entire new sections do need to be added manually, though.)sidebar_positionin the front matter to organize the position of docs in the sidebar. Index pages use multiples of 10, while pages use multiples of 100. This give us a bit of space between sections and pages to add content as needed.How I Tested These Changes
Local build.
Changelog
Updated beta docs directory structure, added index pages to subsections, updated page positioning via sidebars.ts and sidebar_position in page front matter, removed references section and moved YAML reference docs to guides/deploy.