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.

Sign up for GitHub

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

Jump to bottom

Docs: Move docs/README.adoc to docs reference #26670

Merged
merged 1 commit into from
Aug 2, 2022
Merged

Docs: Move docs/README.adoc to docs reference #26670

merged 1 commit into from
Aug 2, 2022

Conversation

ebullient
Copy link
Member

No description provided.

@ebullient ebullient requested a review from maxandersen July 14, 2022 18:41
@maxandersen
Copy link
Member

the content updates are good, but why split the easier to spot/more recognizable README.adoc over 2 separate docs and require newcomers to jump twice?

What am I missing?

@ebullient
Copy link
Member Author

the content updates are good, but why split the easier to spot/more recognizable README.adoc over 2 separate docs and require newcomers to jump twice?

What am I missing?

README.adoc is not used on the website. The other docs are. This avoids having to duplicate information in the README that is otherwise present in published docs.

@maxandersen
Copy link
Member

+1 on this when conflicts resolved.

The linking works nicely on github so easy to find/navigate and the variables info is "advanced" info so not a loss for newcomers.

Actually just realized the readme.adoc is "hidden" inside docs/src/main/asciidoc rather than at docs level - thats for another PR :)

maxandersen
maxandersen approved these changes Aug 1, 2022
View reviewed changes
Copy link
Member

@maxandersen maxandersen left a comment

Choose a reason for hiding this comment

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

approve when rebased.

@ebullient ebullient merged commit c6ed339 into quarkusio:main Aug 2, 2022
@quarkus-bot quarkus-bot bot added this to the 2.12 - main milestone Aug 2, 2022
@ebullient ebullient deleted the docs-readme branch August 2, 2022 14:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maxandersen maxandersen maxandersen approved these changes

Assignees
No one assigned
Labels
area/documentation
Projects
None yet
Milestone
2.12.0.CR1
Development

Successfully merging this pull request may close these issues.
2 participants
@ebullient @maxandersen