Add a getting started guide for control plane projects #1110
+3,468
−0
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| --- | ||
|
Member
There was a problem hiding this comment. will you add this to v2.3 also so it shows up in latest?
Member
Author
There was a problem hiding this comment. Yep, I'll copy it to v2.3 and the new v2.4. Figured it would be easier to review and update in master first :-). |
||
| title: "Get Started" | ||
| weight: 200 | ||
| description: "Get started with the Crossplane CLI" | ||
| --- | ||
|
|
||
| {{< auto-index >}} | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
would it make sense to link this new guide somehow from the core crossplane docs getting started section for more visibility? i.e. maybe a placeholder page so it shows up in that nav pane, but that page then just has a short intro and link to this content?
that may make things confusing, so feel free to disregard, just thinking of more ways to make this new guide discoverable
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea. I thought about adding a note in the header of the existing "get started with compositions" page, but there's already a lot of frontmatter there so it kinda gets lost. I've taken your suggestion and added a stub page in that section that links to the CLI docs. Open to suggestions on where it sits in the nav and its content.