Skip to content

chore: update Getting Started landing page #783

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 10, 2022
Merged

Conversation

khorne3
Copy link
Contributor

@khorne3 khorne3 commented Jan 6, 2022

  • simplified index.md to draw attention to contents of the section
  • moved a lot of the existing content on index.md to admin.md

@khorne3 khorne3 changed the title chore: fix Getting Started landing page chore: update Getting Started landing page Jan 6, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Jan 6, 2022

✨ Coder.com for PR #783 deployed! It will be updated on every commit.

Copy link
Member

@bpmct bpmct left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is clear to me!

However, the home of docs doesn't really link to either of these, instead linking to the "Getting started" for workspaces. And "Setup" and "Admin" CTAs. How will that work with this new getting started content?

@ericpaulsen
Copy link
Member

Generally speaking, I sense that the paragraph format might not be as inviting and efficient to read. For a Getting Started guide, I think a bulleted list of items to review, configure, etc. might be easier to read through. E.g.:

Set up and deploy Coder

To get started with Coder, you'll need to install the necessary infrastructure and deploy Coder via Helm. We have documentation to walk you through each step:

etc...

Thoughts? @khorne3 @bpmct @mterhar @jawnsy

@khorne3
Copy link
Contributor Author

khorne3 commented Jan 10, 2022

@bpmct I think I'll replace the Getting Started link (in the hero image) with a link to the getting started guides instead of to workspaces/editors -- I think this accomplishes the same thing, but with better context and instructions

@ericpaulsen That's a good point; I'll edit and we can take a look

@ericpaulsen
Copy link
Member

Looks good! Only a couple things before we merge:

  • The numbering is off with the bulleted items in the Configure Coder section
  • The Additional Information section seems to be incomplete

Thanks @khorne3

@khorne3 khorne3 merged commit 86064f1 into main Jan 10, 2022
@khorne3 khorne3 deleted the getting-started-fixes branch January 10, 2022 22:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants