Readme Get Started Section #4465
Conversation
Add section for Getting Started Signed-off-by: Shane Miller <60621688+shanecmiller23@users.noreply.github.com>
README.md
Outdated
| @@ -11,6 +11,10 @@ control of the schema of the declarative API it offers. | |||
|
|
|||
| Crossplane is a [Cloud Native Computing Foundation][cncf] project. | |||
|
|
|||
| ## Getting Started | |||
|
|
|||
| Crossplane's [Getting Started Documentation](https://docs.crossplane.io/v1.13/getting-started/) covers Crossplane installation and cloud provider quickstarts. | |||
There was a problem hiding this comment.
Is there some kind of latest link we can use? Just to remove one more place we'll need to keep the URL fresh as new versions are released.
Other than that, LGTM. Could you wrap at 80 chars to match the rest of the doc though?
There was a problem hiding this comment.
Use /latest instead of the version for an evergreen link
fix version linking Signed-off-by: Shane Miller <60621688+shanecmiller23@users.noreply.github.com>
README.md
Outdated
| @@ -11,6 +11,10 @@ control of the schema of the declarative API it offers. | |||
|
|
|||
| Crossplane is a [Cloud Native Computing Foundation][cncf] project. | |||
|
|
|||
| ## Get Started | |||
|
|
|||
| Crossplane's [Getting Started Documentation](https://docs.crossplane.io/latest/getting-started/) covers Crossplane installation and cloud provider quickstarts. | |||
There was a problem hiding this comment.
Link looks good to me now @shanecmiller23, but can you still wrap this new content to 80 chars so it's consistent with the rest of the file? 😇
Feel free to also squash down to a single commit to keep the history clean 🤓
There was a problem hiding this comment.
@jbw976 updated. I don't know how to squash down to a single commit, would that just entail opening a new PR?
There was a problem hiding this comment.
no sir, you can squash using a git interactive rebase, but let's not worry about that 🤓 - we can also let github do it for us when we merge the PR.
But I'm still not seeing this line wrapped at 80 chars, did you push a commit for that? See the screenshot below where the new line here goes much wider than the other lines in the doc? do you see differently? 🤔
There was a problem hiding this comment.
@jbw976 it does go longer in that screenshot, but that's only because it includes a full URL that will be the hidden destination for the link text. So in the actual readme that URL part won't show
There was a problem hiding this comment.
yep agreed that it does get wrapped when it's fully rendered @shanecmiller23! what i'm getting at here though is that we want to keep the raw markdown clean and having a consistent style. So in the raw markdown we like to do the following:
- wrap all the content at 80 chars (or immediately after a link if the link goes past 80 chars). A tool like Rewrap helps a lot with this.
- we prefer "reference style links" over "inline style links", so we may as well update that while we're here 🤪 - relevant doc: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#links
So putting that together, I'd expect your contribution here to look like this in the raw markdown:
## Get Started
Crossplane's [Getting Started Docs] cover install and cloud provider
quickstarts.
Then at the bottom of the doc, you'd add this new reference style link value:
[Getting Started Docs]: https://docs.crossplane.io/latest/getting-started/
Does that make sense? I'm sorry for the back and forth here, happy to DM or meet for higher bandwidth discussion if there's any lingering questions. Thank you @shanecmiller23! 🙇
There was a problem hiding this comment.
@jbw976 updated per your comments! apologies on my misunderstanding
revise to be under 80 characters Signed-off-by: Shane Miller <60621688+shanecmiller23@users.noreply.github.com>
fix per Jared's feedback Signed-off-by: Shane Miller <60621688+shanecmiller23@users.noreply.github.com>
shanecmiller23
changed the title
There was a problem hiding this comment.
Thanks @shanecmiller23! appreciate this contribution and iterating on the style preferences ✅
Description of your changes
Add section for Get Started to the Readme. Right now there is no direction for brand new users who stumble upon the GitHub Readme.
I have:
make reviewableto ensure this PR is ready for review.backport release-x.ylabels to auto-backport this PR if necessary.