Antora assembler simplification #910
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Run
perl -ni -e 'print unless /^(\s*$|\/\/)/' \
modules/ROOT/pages/_partials/_show_glossary_links.adoc
...
on the main abstracted partials. This is so that when antora-assembler inlines them,
they won't have extra newlines and // comment lines that confuse the output.
Additionally, manually add a comment to the block_tabbed_code partials, so that
the source of includes can be tracked.
run: ./simplify/simplify.sh This assumes that docs-site and docs-sync-gateway are siblings in the file tree. This sample only updates the android/database.adoc page for now (it builds everything, and all the rest should work in exactly the same way, I just haven't wired that part together yet.)
osfameron
requested review from
simon-dew,
ElliotFrancisHunter and
RayOffiah
* Extract `process` call to run on all modules, and all asciidoc files
* {tabs} declarations get mangled
(possibly same issue as https://gitlab.com/antora/antora-assembler/-/issues/17 ?)
We now de-munge these
these auto-generated anchors break tabs
osfameron
added a commit
that referenced
this pull request
Oct 10, 2024
Fixing the code samples will require collaboration with @borrrden and co, but in the meantime, we can copy the previous snippets from version 3.0. This requires copying the "simplified" version from #910 and making some changes: * fix image location to :ROOT: * remove additional == 2 levels of header as well as copy/pasting code from the previous output into the source snippets as appropriate.
osfameron
added a commit
that referenced
this pull request
Oct 10, 2024
Fixing the code samples will require collaboration with @borrrden and co, but in the meantime, we can copy the previous snippets from version 3.0. This requires copying the "simplified" version from #910 and making some changes: * fix image location to :ROOT: * remove additional == 2 levels of header as well as copy/pasting code from the previous output into the source snippets as appropriate.
Remove // comments where unneeded
RayOffiah
approved these changes
Oct 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
WIP with antora-assembler
Android database page looks pretty good to me, but haven't done full test!