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

Qute docs improvement #44289

Closed
wants to merge 11 commits into from
Closed

Qute docs improvement #44289

wants to merge 11 commits into from

Conversation

melloware
Copy link
Contributor

Fix #44261

docs/src/main/asciidoc/qute.adoc Outdated Show resolved Hide resolved
docs/src/main/asciidoc/qute.adoc Outdated Show resolved Hide resolved
Copy link

github-actions bot commented Nov 4, 2024

🙈 The PR is closed and the preview is expired.

This comment has been minimized.

@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

docs/src/main/asciidoc/qute.adoc Outdated Show resolved Hide resolved
docs/src/main/asciidoc/qute.adoc Outdated Show resolved Hide resolved
Co-authored-by: Neon <[email protected]>
Update docs/src/main/asciidoc/qute.adoc

Co-authored-by: Neon <[email protected]>
Qute docs improvement
Update docs/src/main/asciidoc/qute.adoc

Co-authored-by: Neon <[email protected]>
Qute docs improvement

This comment has been minimized.

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.

Copy link
Contributor

@neon-dev neon-dev left a comment

Choose a reason for hiding this comment

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

What do you think about these changes?

docs/src/main/asciidoc/qute.adoc Outdated Show resolved Hide resolved
docs/src/main/asciidoc/qute.adoc Outdated Show resolved Hide resolved
docs/src/main/asciidoc/qute.adoc Outdated Show resolved Hide resolved
docs/src/main/asciidoc/qute.adoc Outdated Show resolved Hide resolved
docs/src/main/asciidoc/qute.adoc Outdated Show resolved Hide resolved
docs/src/main/asciidoc/qute.adoc Outdated Show resolved Hide resolved
docs/src/main/asciidoc/qute.adoc Outdated Show resolved Hide resolved
docs/src/main/asciidoc/qute.adoc Outdated Show resolved Hide resolved
docs/src/main/asciidoc/qute.adoc Outdated Show resolved Hide resolved
Goodbye {name}! <1>
----
<1> `{name}` is a value expression that is evaluated when the template is rendered.

Now let's declare and use those templates in the resource class.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Now let's declare and use those templates in the resource class.
Now let's declare and use this template in the resource class.

@melloware
Copy link
Contributor Author

I am gonna close this. @neon-dev can you submit a new PR please?

@melloware melloware closed this Nov 20, 2024
@melloware melloware deleted the Q44261 branch November 20, 2024 16:40
@quarkus-bot quarkus-bot bot added the triage/invalid This doesn't seem right label Nov 20, 2024
@neon-dev
Copy link
Contributor

I am gonna close this. @neon-dev can you submit a new PR please?

#44602

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

Successfully merging this pull request may close these issues.

Improve Qute documentation
4 participants