Skip to content
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

Docs: Add getting started section on the home page of doc #392

Closed
ijemmy opened this issue Jan 3, 2022 · 3 comments
Closed

Docs: Add getting started section on the home page of doc #392

ijemmy opened this issue Jan 3, 2022 · 3 comments
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation

Comments

@ijemmy
Copy link
Contributor

ijemmy commented Jan 3, 2022

Description of the improvement

Summary of the proposal
As a user, I want to see “Getting started” first. I am not interested in Tenets so I find it not so user friendly to have that as the first section when I see the doc. I have to jump to Installation (and then go to individual core utility page) to get start.

I propose having this as the first section in the home page. It should have accompanied code for running in an actual environment (e.g. cookie cutter project in #391 ). It should support popular tools like:

  1. CDK (we have already had this in examples/cdk folder)
  2. Serverless Framework
  3. SAM

How, where did you look for information
examples/cdk folder. This is not explicitly linked in Doc.

Missing or unclear documentation
N/A

Improvement
N/A

Related existing documentation

N/A

Related issues, RFCs

#391

@ijemmy ijemmy added the documentation Improvements or additions to documentation label Jan 3, 2022
@dreamorosi
Copy link
Contributor

See also #385 for examples

@dreamorosi dreamorosi added this to the production-ready-release milestone Jan 3, 2022
@saragerion saragerion added the triage This item has not been triaged by a maintainer, please wait label Jan 21, 2022
@dreamorosi dreamorosi changed the title docs(all): Add getting started section on the home page of doc Documentation (all): Add getting started section on the home page of doc May 12, 2022
@saragerion saragerion removed this from the production-ready-release milestone May 16, 2022
@dreamorosi
Copy link
Contributor

In #1133 we have updated the format/ordering of sections of the homepage.

Readers now have more actionable items on top: how to install, how to use with popular framework, link to examples, env variable, and finally tenets.

I'll be closing this issue for the time being, but in case anyone lands here because they find the docs unclear please open a new issue to discuss additional changes.

@dreamorosi dreamorosi removed priority:medium triage This item has not been triaged by a maintainer, please wait labels Nov 9, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Nov 9, 2022

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

@dreamorosi dreamorosi changed the title Documentation (all): Add getting started section on the home page of doc Docs (all): Add getting started section on the home page of doc Nov 14, 2022
@dreamorosi dreamorosi added the completed This item is complete and has been merged/shipped label Nov 14, 2022
@dreamorosi dreamorosi changed the title Docs (all): Add getting started section on the home page of doc Docs: Add getting started section on the home page of doc Nov 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants