Conversation
There was a problem hiding this comment.
Some initial feedback (based on my first impressions):
- You open the page with a section entitled "Quickstart", which (IMHO) is what it should be. So why not rename the page as Quickstart?
- I think that we should have a single Quickstart page (not a section with subpages).
- The page looks "heavy":
- I'd vote to refer to an "Install" step with instructions from another page (like https://etcd.io/docs/v3.4/dl-build/ or an equivalent / improved "Install" page).
- Formatting the steps are markdown numbered list entries would help make the page lighter.
chalin
left a comment
There was a problem hiding this comment.
As I mentioned out-of-band, I think that the most important is to agree on the following, first: section vs. single page -- I don't think that we need more than one such page. (I think that Get started is fine as a name.)
For more detailed comments about the Get started page, see my inlined comments.
Thanks!
bf9cdcc to
aa3ceab
Compare
|
new deploy preview: https://deploy-preview-278--etcd.netlify.app/docs/next/quickstart/ |
A lot of this has come from the http://play.etcd.io/install page, but I'm not sure I want to link to it as it's not wholly correct (some links are still pointing at coreos for example)
I'm not sure what you mean here. |
chalin
left a comment
There was a problem hiding this comment.
It's coming along. See inlined comments.
|
Thanks for the feedback @chalin, updates are in. |
spzala
left a comment
There was a problem hiding this comment.
Please see couple of inline comments. Thanks!
|
The latest commits:
Previews: |
|
I'm not sure if 'Quickstart' should be in the top nav, or linked as another button alongside |
spzala
left a comment
There was a problem hiding this comment.
With the added link to run etcd from main branch, I am good with the changes. lgtm. Thanks!
2065e4b to
6676d80
Compare
|
Just noticed a funny typo in the PR title: I've heard of poptarts but not Quicktarts 😉 |
chalin
left a comment
There was a problem hiding this comment.
A first quick comment (more to come): I believe that the best place to add a link to the Quickstart page is via the CTA button on the homepage, replacing the "Docs (->)" button.
I'd vote to exclude the Quickstart link from the top-nav.
In an alternate universe maybe 😄 |
I think that's a good place for it too. I'll make that update.
+1 |
content/en/docs/next/quickstart.md
Outdated
|
|
||
| ## Next steps | ||
|
|
||
| Now it's time to dig into the full etcd API and other guides. |
There was a problem hiding this comment.
I think that we can be gentler here and invite the reader to do something.
Learn about more ways to configure and use etcd from the following pages:
Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
6676d80 to
5587db6
Compare
Thanks @spzala for the feedback. Merging now. |
* Quickstart for etcd Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com> * Fix launch-etcd command (x2) Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Simple quick start guide for downloading etcd.
The quickstart file is in
nextto start, but should be able to be copied almost verbatim into the current/latest version once the structure and content have been reviewed.Deploy preview:
Closes: #218
Contributes to: #81