DOC-878 Reorganize and clean up Components docs #27848
Conversation
…tent examples file 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
|
Hey @neverett could you post a link to the preview website? That would make this easier to review. |
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Sure thing, with the caveat that this is still a work in progress until EOD today (although the high level structure is now in place). I can update again when I'm finished making changes. |
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]>
|
I think we should frame "Migrating to Components" to "Incrementally Adopting Componets" which I think is both more accurate and less scary. |
|
|
||
| :::info | ||
|
|
||
| This feature is still in development and might change in patch releases. It’s not production ready, and the documentation may also evolve. Stay tuned for updates. |
There was a problem hiding this comment.
@neverett This isn't related to this PR, but I find these inline comments from vale to be super noisy. Can we suppress them in this view and surface them elsewhere?
There was a problem hiding this comment.
Yeah, I made a ticket to tune/reconfigure Vale a few weeks ago, I can prioritize that after this PR is merged. I agree, it's super noisy and distracting.
There was a problem hiding this comment.
Noticing some things along the way and making follow up tasks (e.g. https://linear.app/dagster-labs/issue/BUILD-723/move-reference-to-is-component-lib-into-a-later-section-the-tutorial)
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
| @@ -1,6 +1,6 @@ | |||
| --- | |||
| title: 'Making an existing code location components-compatible' | |||
| sidebar_position: 300 | |||
| title: 'Migrating an existing code location to components' | |||
There was a problem hiding this comment.
Can you change these subpages as well to include incremental adoption language?
There was a problem hiding this comment.
This is really "Using components in an existing code location"
There was a problem hiding this comment.
Ah yeah, that makes more sense
| @@ -1,10 +1,10 @@ | |||
| --- | |||
| title: 'Migrating existing definitions to components' | |||
There was a problem hiding this comment.
Using existing definitions within components
Signed-off-by: nikki everett <[email protected]>
|
@schrockn I pushed some changes while you were commenting, but will update those subpages accordingly. |
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]>
|
@schrockn updated subpages and redirects, so this is ready for another review. Thanks! |
There was a problem hiding this comment.
Great thank you! Please let @benpankow know when this as he has outstanding content read to merge I believe.
Signed-off-by: nikki everett <[email protected]>
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
| - path: replication.yaml | ||
| asset_attributes: | ||
| - target: "*" | ||
| attributes: |
There was a problem hiding this comment.
The indentation on line 3 uses a tab character which will cause YAML parsing errors. Replace the tab with spaces to maintain consistent indentation with the rest of the file.
Spotted by Graphite Reviewer
Is this helpful? React 👍 or 👎 to let us know.
| - path: replication.yaml | ||
| asset_attributes: | ||
| - target: "*" | ||
| attributes: |
There was a problem hiding this comment.
The indentation on line 4 uses a tab character which will cause YAML parsing errors. Replace the tab with spaces to match the surrounding indentation level. YAML is space-sensitive and does not handle tabs well.
Spotted by Graphite Reviewer
Is this helpful? React 👍 or 👎 to let us know.
Signed-off-by: nikki everett <[email protected]>
Summary & Motivation
Reorganize according to proposed new IA and copyedit existing content.
How I Tested These Changes
Changelog