Skip to content

Polish README #3314

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

Conversation

ngocnhan-tran1996
Copy link
Contributor

I've tried to build the documentation on my local machine, but it didn't work.

https://github.com/spring-projects/spring-data-commons?tab=readme-ov-file#building-reference-documentatio

It only worked when I added antora:antora at the end, and the generated documentation was available at /target/site/index.html.
I'm using Windows OS, so there might be differences compared to other OS.

Please check, and if it's correct, I will update it in this PR.

Signed-off-by: Tran Ngoc Nhan <[email protected]>
@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Jun 16, 2025
@mp911de mp911de added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged labels Jun 17, 2025
@mp911de mp911de self-assigned this Jun 17, 2025
@mp911de
Copy link
Member

mp911de commented Jun 17, 2025

Thanks for your contribution. For the Antora build, we use the -Pantora profile. I've fixed the profile and the target path in a follow-up commit.

mp911de pushed a commit that referenced this pull request Jun 17, 2025
mp911de added a commit that referenced this pull request Jun 17, 2025
Fix documentation build profile and path.

See #3314
@mp911de mp911de closed this in e506aa8 Jun 17, 2025
mp911de added a commit that referenced this pull request Jun 17, 2025
Fix documentation build profile and path.

See #3314
mp911de pushed a commit that referenced this pull request Jun 17, 2025
mp911de added a commit that referenced this pull request Jun 17, 2025
Fix documentation build profile and path.

See #3314
@mp911de mp911de added this to the 3.4.8 (2024.1.8) milestone Jun 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants