Skip to content

Revamp the Extending, Plugins, Architecture, and Programmatic configuration pages#2696

Merged
vy merged 48 commits into2.xfrom
doc/2.x/extending
Jul 3, 2024
Merged

Revamp the Extending, Plugins, Architecture, and Programmatic configuration pages#2696
vy merged 48 commits into2.xfrom
doc/2.x/extending

Conversation

@vy
Copy link
Copy Markdown
Member

@vy vy commented Jul 1, 2024

This PR addresses #2530.

vy and others added 30 commits June 2, 2024 22:15
Co-authored-by: Piotr P. Karwasz <piotr.github@karwasz.org>
Co-authored-by: Piotr P. Karwasz <piotr.github@karwasz.org>
# Conflicts:
#	src/site/antora/modules/ROOT/pages/manual/customloglevels.adoc
# Conflicts:
#	src/site/antora/modules/ROOT/examples/manual/customloglevels/log4j2.json
#	src/site/antora/modules/ROOT/pages/manual/customloglevels.adoc
Editing a Ditaa source requires significant Ascii art
skills, which makes it difficult to modify. This contradicts
with our initial motivation to move away from images.
Switching to PlantUML instead, which is a no-brainer to
use and adapt.
@vy vy added the documentation Pull requests or issues that affect documentation label Jul 1, 2024
@vy vy requested a review from ppkarwasz July 1, 2024 07:12
@vy vy self-assigned this Jul 1, 2024
Copy link
Copy Markdown
Contributor

@ppkarwasz ppkarwasz left a comment

Choose a reason for hiding this comment

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

Thanks for revamping all these pages!

For now I reviewed only customconfig.adoc. Given the quality of the original, full of wrong or deprecated examples, I see a net improvement in the page.
Yet there are still some corrections to do.

Comment thread src/site/resources/.htaccess Outdated
Comment thread src/site/antora/modules/ROOT/pages/manual/customconfig.adoc Outdated
Comment thread src/site/antora/modules/ROOT/pages/manual/customconfig.adoc
Comment thread src/site/antora/modules/ROOT/pages/manual/customconfig.adoc Outdated
Comment thread src/site/antora/modules/ROOT/pages/manual/customconfig.adoc Outdated
Comment thread src/site/antora/modules/ROOT/pages/manual/customconfig.adoc Outdated
Comment thread src/site/antora/modules/ROOT/pages/manual/customconfig.adoc
vy added 6 commits July 1, 2024 21:02
The browser does not send the fragment part to the server, when
requesting a page. So all redirects from `a.html#fragment` to
`b.html` will not work.

On the other hand you can redirect `a.html` to `b.html#fragment`,
but you need to add the NE (disables escaping) flag.
@vy vy requested a review from ppkarwasz July 1, 2024 20:03
vy and others added 2 commits July 1, 2024 22:04
Copy link
Copy Markdown
Contributor

@ppkarwasz ppkarwasz left a comment

Choose a reason for hiding this comment

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

Regarding the Extending page, I have a couple of comments.

Comment thread src/site/antora/modules/ROOT/pages/manual/extending.adoc Outdated
Comment thread src/site/antora/modules/ROOT/pages/manual/extending.adoc Outdated
Comment thread src/site/antora/modules/ROOT/pages/manual/extending.adoc
Comment thread src/site/antora/modules/ROOT/pages/manual/extending.adoc
Copy link
Copy Markdown
Contributor

@ppkarwasz ppkarwasz left a comment

Choose a reason for hiding this comment

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

The Plugins page seems really nice! 💯

Comment thread src/site/antora/modules/ROOT/pages/manual/plugins.adoc
Comment thread src/site/antora/modules/ROOT/pages/manual/plugins.adoc Outdated
Comment thread src/site/antora/modules/ROOT/pages/manual/plugins.adoc Outdated
Comment thread src/site/antora/modules/ROOT/pages/manual/plugins.adoc
@vy vy merged commit 466ac59 into 2.x Jul 3, 2024
@vy vy deleted the doc/2.x/extending branch July 3, 2024 08:06
This was referenced Jul 3, 2024
vy added a commit that referenced this pull request Jul 5, 2024
…configuration` pages (#2696)

This work ports 466ac59 to `main`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Pull requests or issues that affect documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants