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

Add guidance for creating a Quarkus doc abstract #27286

Merged
merged 2 commits into from Aug 16, 2022

Conversation

michelle-purcell
Copy link
Contributor

As a contributor to the Quarkus community project, I'd like to know how to write a good extract that helps Quarkus readers to find, skim and understand our content and uses best practices for search engine optimization.

@michelle-purcell
Copy link
Contributor Author

michelle-purcell commented Aug 15, 2022

@MichalMaler - I started the guidance for 'Abstracts' that clarifies the importance of the first sentence and how it gets used to dynamically populate the summary blurb on the Quarkusio home page.
Please can you review and add more guidance about abstracts if you think it's needed? Thanks :-)

Quarkus Documentation automation moved this from To do to Reviewer approved Aug 15, 2022
@ebullient ebullient marked this pull request as ready for review August 15, 2022 14:56
@ebullient
Copy link
Contributor

I'm ok to merge this..

@ebullient ebullient merged commit 8764ba4 into quarkusio:main Aug 16, 2022
Quarkus Documentation automation moved this from Reviewer approved to Done Aug 16, 2022
@quarkus-bot quarkus-bot bot added this to the 2.12 - main milestone Aug 16, 2022
@MichalMaler
Copy link
Contributor

As a contributor to the Quarkus community project, I'd like to know how to write a good extract that helps Quarkus readers to find, skim and understand our content and uses best practices for search engine optimization.

Hello @michelle-purcell , adding my feedback here :)
#27302

@michelle-purcell
Copy link
Contributor Author

@inoxx03 FYI

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

None yet

3 participants