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

Fix the family directory structure #169

Merged
merged 1 commit into from
Jan 10, 2022
Merged

Conversation

mmattel
Copy link
Contributor

@mmattel mmattel commented Jan 9, 2022

This is the Desktop part of fixing the family directory structure of Antora, see: https://docs.antora.org/antora/2.3/standard-directories/

The current structure is not prepared for Antora 3.x

Note that the navigation file is now moved into the partials directory which is necessary to access it from the outside. If a file is not part of a family directory, it cant be referenced or included with the exeption of antora.yml.

Backporting: 2.10 can be done with the backporting script, for the other branches this is a manual task. The bin/find-orphand-* files and the makepdf file can be "copied", but the move of the directories, the navigation files, respectvely the creation of missing directories must be made manually to secure nothing gets into the branches that should not be there.

Referencing: owncloud/docs#4128 (Replace the depreciated Antora family resource identifier with the actual valid once)

Copy link
Contributor

@phil-davis phil-davis left a comment

Choose a reason for hiding this comment

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

TBH I am not familiar with all this! Approving so that you can move forward and merge this, and double-check that it all worked by checking the resulting docs that get published.

@mmattel mmattel merged commit 8408bad into master Jan 10, 2022
@delete-merged-branch delete-merged-branch bot deleted the fix_family_directories branch January 10, 2022 10:31
mmattel added a commit that referenced this pull request Jan 10, 2022
mmattel added a commit that referenced this pull request Jan 10, 2022
mmattel added a commit that referenced this pull request Jan 10, 2022
mmattel added a commit that referenced this pull request Jan 10, 2022
mmattel added a commit that referenced this pull request Jan 10, 2022
mmattel added a commit that referenced this pull request Jan 10, 2022
mmattel added a commit that referenced this pull request Jan 10, 2022
mmattel added a commit that referenced this pull request Jan 10, 2022
mmattel added a commit that referenced this pull request Jan 10, 2022
[2.10] [PR 176] Fix for makepdf refs #169
mmattel added a commit that referenced this pull request Jan 10, 2022
[2.9] [PR 176] Fix for makepdf refs #169
mmattel added a commit that referenced this pull request Jan 10, 2022
[2.8] [PR 176] Fix for makepdf refs #169
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants