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

[Antora] [PGSQL] Architecture section for postgres doc #5189

Closed
Arsnael opened this issue May 15, 2024 · 1 comment
Closed

[Antora] [PGSQL] Architecture section for postgres doc #5189

Arsnael opened this issue May 15, 2024 · 1 comment
Assignees
Labels
Documentation Contributes some documentation changes

Comments

@Arsnael
Copy link
Member

Arsnael commented May 15, 2024

Same structure as distributed doc: https://james.staged.apache.org/james-distributed-app/3.8.1/architecture/index.html

For this, you will need to refactor the distributed doc as well, as some parts can be shared with postgres doc.

  • Architecture page: Storage is pg specific I think (slightly different) but other sections can be partial with distributed

    • Implemented standards => partials
    • Consistency model => Opensearch and RabbitMQ consistency model can be partials
    • Specialized instances => partials

Some pages between distributed and postgres docs can be very similar, with the only difference being the server appellation Distributed James Server versus Postgresql James Server. For this, could use attributes in partials => https://docs.antora.org/antora/latest/page/page-attributes/#custom-attribute

Could setup default attributes in partials to be the ones from distributed, and only overriding them for postgres doc.

Make sure as well that distributed doc is still the same after refactoring.

@Arsnael Arsnael added Documentation Contributes some documentation changes grooming labels May 15, 2024
@Arsnael Arsnael removed the grooming label May 27, 2024
@vttranlina vttranlina self-assigned this Jul 3, 2024
@vttranlina
Copy link
Member

pr apache#2335

@Arsnael Arsnael closed this as completed Jul 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Contributes some documentation changes
Projects
None yet
Development

No branches or pull requests

2 participants