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: enrich the landing page with basic concepts #472

Merged

Conversation

IronCore864
Copy link
Contributor

@IronCore864 IronCore864 commented Aug 5, 2024

Improve the definition of Pebble and add fundamentals.

In the current version, it only describes what Pebble can do, but most product docs start with defining "what it is", like supervisor, runit, etc, so I expanded the definition a little bit.

Also added a section as prerequisite. Maybe it is not necessary, please provide your feedback. I think it doesn't hurt because it has a few links to ubuntu.com.

Closes #465.

@IronCore864 IronCore864 marked this pull request as ready for review August 5, 2024 09:55
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
@benhoyt
Copy link
Contributor

benhoyt commented Aug 5, 2024

@AnneCYH Isn't there a standard structure we use for home page introductions? I think I remember Dora mentioning something like that.

Copy link
Contributor

@benhoyt benhoyt left a comment

Choose a reason for hiding this comment

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

I think this is fine as an incremental improvement - thanks.

@AnneCYH
Copy link
Contributor

AnneCYH commented Aug 7, 2024

hi @benhoyt , @IronCore864 ,

The standard landing page for product docs:
https://docs.google.com/document/d/1Zw-UoQzHMSQjATLXjjvd9GKu5qU2mHmqxtKck8nGkbU/edit

There should be ~4 paragraphs to introduce the user to the product.

@AnneCYH
Copy link
Contributor

AnneCYH commented Aug 8, 2024

Hey @IronCore864 , @benhoyt , looks good!

docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
@IronCore864
Copy link
Contributor Author

@AnneCYH Thanks for the review. After a sync with Anne, I have updated the PR according to @benhoyt's suggestion. Please take another look!

Copy link
Contributor

@benhoyt benhoyt left a comment

Choose a reason for hiding this comment

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

Great, let's merge this!

@IronCore864 IronCore864 merged commit 45629c6 into canonical:master Aug 13, 2024
16 checks passed
@IronCore864 IronCore864 deleted the docs-complete-set-of-prerequisites branch August 13, 2024 04:12
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.

Provide a more complete set of prerequisites for the tutorial
3 participants