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

Enhance doc contributor guide with information about creating new content, landing page config, and URL redirection #30043

Merged

Conversation

michelle-purcell
Copy link
Contributor

@michelle-purcell michelle-purcell commented Dec 22, 2022

Enhances the Quarkus docs contributor guide topics. Adds content about:

  • How to retire and redirect an existing published doc page that is renamed so as to prevent bookmarks and other doc links from breaking.
  • How to create a brand new doc file.
  • The repo used to generate the Quarkus documentation index page on the web portal:
    image

@michelle-purcell michelle-purcell force-pushed the QDOCS-70-DOC-CONTRIBUTING branch 2 times, most recently from a0d6ed4 to 5923453 Compare January 11, 2023 17:37
@michelle-purcell michelle-purcell changed the title WIP: Docs- Add landing page & URL redirect info - DRAFT Enhance doc contributor guide with info about creating new Quarkus content types, index page configuration, and URL redirection Jan 11, 2023
@michelle-purcell michelle-purcell changed the title Enhance doc contributor guide with info about creating new Quarkus content types, index page configuration, and URL redirection Enhance doc contributor guide with information about creating new content, landing page config, and URL redirection Jan 11, 2023
@michelle-purcell
Copy link
Contributor Author

@ebullient / @gsmet / other interested community members.
This PR is ready for final review. Many thanks.

[cc - @sheilamjones , @MichalMaler , & @rolfedh )

@quarkus-bot

This comment has been minimized.

Fix typo

Enhance content

enhancements

enhancements

Further enhancements

enhancements

Enhanced some points after discussion with Erin

Update docs/src/main/asciidoc/doc-contribute-docs-howto.adoc

Co-authored-by: Erin Schnabel <ebullientworks@gmail.com>

Update docs/src/main/asciidoc/doc-contribute-docs-howto.adoc

Co-authored-by: Erin Schnabel <ebullientworks@gmail.com>

Update docs/src/main/asciidoc/doc-contribute-docs-howto.adoc

Co-authored-by: Erin Schnabel <ebullientworks@gmail.com>

Added anchors and other minor tweaks
@michelle-purcell
Copy link
Contributor Author

@ebullient - Thanks for your review. All suggestions are now done, squashed and pushed.

@quarkus-bot
Copy link

quarkus-bot bot commented Jan 17, 2023

✔️ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

@ebullient ebullient merged commit 4f36e10 into quarkusio:main Jan 17, 2023
@quarkus-bot quarkus-bot bot added this to the 2.17 - main milestone Jan 17, 2023
@michelle-purcell michelle-purcell deleted the QDOCS-70-DOC-CONTRIBUTING branch May 8, 2023 08:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants