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

Switch to Antora documentation site #765

Merged
merged 13 commits into from
Aug 4, 2023
Merged

Conversation

rwinch
Copy link
Member

@rwinch rwinch commented Aug 3, 2023

No description provided.

@rstoyanchev rstoyanchev added this to the 1.2.3 milestone Aug 4, 2023
@rstoyanchev rstoyanchev self-assigned this Aug 4, 2023
@rstoyanchev rstoyanchev added the type: documentation A documentation task label Aug 4, 2023
Copy link
Contributor

@rstoyanchev rstoyanchev left a comment

Choose a reason for hiding this comment

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

Isn't the antora-playbook.yml meant to be in the docs-build branch, i.e. shared across branches? In spring-framework we have the cached-antora-playbook.yml which is listed .gitignore. I don't see anything added to .gitignore here.

@rwinch
Copy link
Member Author

rwinch commented Aug 4, 2023

@rstoyanchev I'm moving away from the approach of the shared docs-build antora-playbook.yml because it is an non-versioned resource that will be in a tag and potentially break later. I think it is better to just include the playbook in the branches going forward.

If you prefer we can use the shared antora-playbook.yml strategy, but I think this is a better approach.

PS: I haven't started any effort on changing existing builds to use this approach, but I'm doing it going forward.

@rstoyanchev
Copy link
Contributor

Okay thanks for clarifying.

@rstoyanchev rstoyanchev merged commit 29fb329 into spring-projects:main Aug 4, 2023
1 check passed
@rstoyanchev rstoyanchev changed the title Antora Switch to Antora documentation site Aug 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation task
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants