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

Documentation revision / reorganization #25355

Closed
ebullient opened this issue May 4, 2022 · 0 comments · Fixed by #25354
Closed

Documentation revision / reorganization #25355

ebullient opened this issue May 4, 2022 · 0 comments · Fixed by #25354
Assignees
Labels
area/documentation kind/epic Large issue with links to sub-issues
Milestone

Comments

@ebullient
Copy link
Contributor

ebullient commented May 4, 2022

Joint effort with docs, engineering and community to revise docs for better readability / navigability.

In the linked PR, please review:

  • _templates -- base for future docs
  • _examples -- one-off examples used by docs explaining how to write docs
  • doc-concepts.adoc -- skeleton, will eventually explain diataxis concepts
  • doc-contribute-quarkus-docs-howto.adoc -- How-to guide explaining how to contribute to docs
  • doc-create-tutorial.adoc -- A tutorial that describes creating a tutorial
  • doc-reference.adoc -- Detailed reference for Quarkus Docs.
@ebullient ebullient added the kind/epic Large issue with links to sub-issues label May 4, 2022
@ebullient ebullient self-assigned this Jun 7, 2022
@ebullient ebullient added this to In progress in Quarkus Documentation Jun 22, 2022
Quarkus Documentation automation moved this from In progress to Done Jun 24, 2022
@sunayna15 sunayna15 reopened this Jun 24, 2022
Quarkus Documentation automation moved this from Done to In progress Jun 24, 2022
Quarkus Documentation automation moved this from In progress to Done Jun 29, 2022
@quarkus-bot quarkus-bot bot added this to the 2.11 - main milestone Jun 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation kind/epic Large issue with links to sub-issues
Development

Successfully merging a pull request may close this issue.

3 participants