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: New Getting Started Page #538

Merged
merged 6 commits into from
Nov 12, 2024
Merged

Docs: New Getting Started Page #538

merged 6 commits into from
Nov 12, 2024

Conversation

dericksozo
Copy link
Contributor

(docs): Adding the first draft of the new Getting Started page along with the new structure (draft).

@dericksozo dericksozo added the documentation Improvements or additions to documentation label Nov 6, 2024
@dericksozo dericksozo self-assigned this Nov 6, 2024
@dericksozo
Copy link
Contributor Author

dericksozo commented Nov 6, 2024

Hey @PazYanoverr, this PR introduces a new Getting Started page draft that reorganizes our documentation structure. The proposed changes include:

  • New overview page highlighting key platform engineering capabilities
  • Restructured "Getting Started" sidebar section that will feature quickstart (first service creation), dedicated example services section, and In-depth Application introduction serving as documentation table of contents/roadmap

What are your initial thoughts on this first draft and this direction for the getting start sidebar re-structuring?

P.S. - There are some missing links because we'll need to merge the other PRs first.

@PazYanoverr
Copy link
Contributor

PazYanoverr commented Nov 10, 2024

@dericksozo - The "overview" page looks good! I added a few comments.
Regarding the sidebar - I wish it reflects quickly Amplication major capabilities and advantages. A roadmap and examples are nice, but I think we need to "get to the point" much faster here. I.e., have here pages mostly about our live templates, technical debt handling, service catalog, and - maybe- plugins + private plugins. I believe these pages can also appear as part of the "regular" menu, but these issues should be emphasized in the documentation - i.e. in the sidebar menu, in the top menu etc.
WDTY?

docs/welcome.md Outdated Show resolved Hide resolved
docs/welcome.md Outdated Show resolved Hide resolved
docs/welcome.md Outdated Show resolved Hide resolved
docs/welcome.md Outdated Show resolved Hide resolved
docs/welcome.md Outdated Show resolved Hide resolved
docs/welcome.md Outdated Show resolved Hide resolved
docs/welcome.md Outdated Show resolved Hide resolved
docs/welcome.md Outdated Show resolved Hide resolved
docs/welcome.md Outdated Show resolved Hide resolved
docs/welcome.md Outdated Show resolved Hide resolved
@dericksozo
Copy link
Contributor Author

Hello @PazYanoverr,

I implemented the feedback into the Getting Started page. I added a new "Core Platform Features" section to the sidebar, showcasing Platform Console and Private Plugins pages. Once Live Templates and Service Catalog PRs are merged, they will be added to this section. We should also consider creating a dedicated Technical Debt Management page to complete the core feature documentation.

Thoughts?

@PazYanoverr
Copy link
Contributor

@dericksozo - Sounds good. In addition- I fully agree regarding the Technical Debt Management page that should be created. Let's add it as a new task.
One small comment: I think that the Documentation title should "hold" all the pages, not only the two pages of Overview and "Create your first..." -
image

@PazYanoverr PazYanoverr merged commit 1941415 into main Nov 12, 2024
5 checks passed
@PazYanoverr PazYanoverr deleted the docs/new-getting-started branch November 12, 2024 08:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants