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

Qute docs improvement #44289

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Qute docs improvement #44289

wants to merge 1 commit into from
+18 −7

Conversation

melloware
Copy link
Contributor

Fix #44261

@melloware melloware mentioned this pull request Nov 4, 2024
Open
neon-dev
neon-dev suggested changes Nov 4, 2024
View reviewed changes
docs/src/main/asciidoc/qute.adoc Outdated Show resolved Hide resolved
docs/src/main/asciidoc/qute.adoc Outdated Show resolved Hide resolved
@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 4, 2024 •
edited
Loading

🎊 PR Preview 4968e01 has been successfully built and deployed to https://quarkus-pr-main-44289-preview.surge.sh/version/main/guides/

  • Images of blog posts older than 3 months are not available.
  • Newsletters older than 3 months are not available.

@quarkus-bot quarkus-bot

This comment has been minimized.

Sign in to view
@melloware melloware force-pushed the Q44261 branch 5 times, most recently from de6d636 to f8e042f Compare November 4, 2024 14:17
@melloware
Copy link
Contributor Author

@neon-dev please re-review i think i got all your changes

neon-dev
neon-dev suggested changes Nov 4, 2024
View reviewed changes
docs/src/main/asciidoc/qute.adoc Outdated Show resolved Hide resolved
docs/src/main/asciidoc/qute.adoc Show resolved Hide resolved
@melloware
Update docs/src/main/asciidoc/qute.adoc
e45d719 
Co-authored-by: Neon <1169307+neon-dev@users.noreply.github.com>
Update docs/src/main/asciidoc/qute.adoc

Co-authored-by: Neon <github@undiscover.de>
Qute docs improvement
Update docs/src/main/asciidoc/qute.adoc

Co-authored-by: Neon <github@undiscover.de>
Qute docs improvement
@quarkus-bot quarkus-bot
Copy link

quarkus-bot bot commented Nov 4, 2024

Status for workflow Quarkus Documentation CI

This is the status report for running Quarkus Documentation CI on commit e45d719.

✅ 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.

mkouba
mkouba reviewed Nov 4, 2024
View reviewed changes
Copy link
Contributor

@mkouba mkouba left a comment

Choose a reason for hiding this comment

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

Hm, when I think about it, we probably should not make this change at all.

It does not make sense to introduce the goodbye.txt template in the example itself.

The sentence with ItemResource is about grouping templates per resource class (unrelated to the hello example).

CC @FroMage who is the author of the original text about type-safe templates.
CC @ia3andy

@FroMage
Copy link
Member

FroMage commented Nov 4, 2024

Yeah, it doesn't add a lot of value to document the second template, we could change the sentence to not mention the second template by name, though, so that people would not think that one is missing from the docs.

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

@mkouba mkouba mkouba left review comments

@neon-dev neon-dev neon-dev approved these changes

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
area/documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve Qute documentation
4 participants
@melloware @FroMage @mkouba @neon-dev