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

Generate the attributes.adoc file during the build #28581

Merged
merged 1 commit into from Oct 14, 2022

Conversation

gsmet
Copy link
Member

@gsmet gsmet commented Oct 13, 2022

Currently, we maintain a copy of the attributes.adoc in the website and we always get it wrong when we add a new attribute.

This way, attributes.adoc will come directly from the release and will be complete.
Attributes that can be overridden have been moved to attributes-local.adoc. attributes-local.adoc won't be overwritten when syncing.

@ebullient this should solve the problem of having to (badly) sync the attributes between the main repository and the website. The attributes.adoc file will now be generated and synced and I created a new attributes-local.adoc file that is not synced and can be overridden (typically for paths that are specific to the environment).

@ebullient
Copy link
Contributor

Hmm. Can we flip this around a little so local previews still work? All of the docs reference include::./attributes.adoc[], which needs to exist for local preview to be functional.

@gsmet
Copy link
Member Author

gsmet commented Oct 13, 2022

What do you call local preview?
And what do you mean by flipping around?

The attributes.adoc file needs to be generated. But it's around as soon as the doc is built via Maven at least once. And if they don't do that, they end up with a ton of issues anyway.

Now we could reapply the src/main/asciidoc/ files on top of the copy in the sync script if it makes things easier for you.

But really, be more precise about what you expect.

@ebullient
Copy link
Contributor

ebullient commented Oct 13, 2022

image

Raw edit in the IDE. This is the easiest way to edit docs with feedback, so I've been trying to make sure using preview works.

We could update all of the files to reference asciidoc-local.adoc, or preserve the attributes.adoc and have that include the generated/common/updated one...

Currently, we maintain a copy of the attributes.adoc in the website and
we always get it wrong when we add a new attribute.

This way, attributes.adoc will come directly from the release and will
be complete.
Attributes that can be overridden has been moved to
attributes-local.adoc. attributes-local.adoc won't be overwritten when
syncing.
@gsmet
Copy link
Member Author

gsmet commented Oct 14, 2022

@ebullient would this new version work for you?

For local preview, attributes will contain the Maven properties but I think it's acceptable as it improves our workflow a lot. And I'm not sure they were properly replaced before anyway.

@ebullient
Copy link
Contributor

ebullient commented Oct 14, 2022

@ebullient would this new version work for you?

YES! 🎉

For local preview, attributes will contain the Maven properties but I think it's acceptable as it improves our workflow a lot. And I'm not sure they were properly replaced before anyway.

Correct, the property values weren't replaced before either. So that's fine.

Quarkus Documentation automation moved this from To do to Reviewer approved Oct 14, 2022
@gsmet gsmet merged commit 76d22ae into quarkusio:main Oct 14, 2022
Quarkus Documentation automation moved this from Reviewer approved to Done Oct 14, 2022
@quarkus-bot quarkus-bot bot added this to the 2.14 - main milestone Oct 14, 2022
@gsmet gsmet modified the milestones: 2.14 - main, 2.13.3.Final Oct 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

None yet

2 participants