[
https://issues.apache.org/jira/browse/JAMES-2394?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17140147#comment-17140147
]
Benoit Tellier commented on JAMES-2394:
---------------------------------------
One "big" problem we have today is that a given documentation files is relevant
for several servers.
We end up saying "ah and euh this configuration is not applicable for you".
I think we need to completly avoid that sheme again for the new documentation
and we should get it adressed with the file hierarchy. I propose:
{code:java}
- Basic Server (see relevant JIRA for file inclusion/exclusion - we don't
document all possible values)
- imapServer.xml
- smtpServer.xml
- mailetContainer.xml (optional, should be oriented toward use cases like
specifying an SMTP gateway, DKIM/SPF records. Maybe we should be exposing some
templates here)
- logback.xml
- Advanced Server [Today configuration documentation, centered on the advanced
server (remove unrelevant documentation entries), organized the way you
proposed it]
- Core components:
- Domain list
- DNS
- Mailet containet
- MailRepositoryStore
- RRT
- Protocols
- SMTP/LMTP
- IMAP4
- POP3
- FetchMail
- Sieve
- Backend specific configuration
- JPA postgrey
- Guice specific configuration
- listeners
- How to...
- Anti-Spam
- Dizstributed Server [Today configuration documentation, centered on the
advanced server (remove unrelevant documentation entries), organized the way
you proposed it]
{code}
Let's skip Spring documentation for now IMO.
> Re-organize configure section
> -----------------------------
>
> Key: JAMES-2394
> URL: https://issues.apache.org/jira/browse/JAMES-2394
> Project: James Server
> Issue Type: New Feature
> Components: configuration, Documentation
> Reporter: Benoit Tellier
> Priority: Major
>
> I would like to propose to re-organize `configure` section of James website.
> Currently, many pages about many different topics are mixed together, making
> it hard to differenciate the various topics.
> Also the current navigation menu do not reflect well the impact of wiring on
> the configuration: some components are only available under some packagings,
> and thus their configuration is wiring solution specific.
> I'd like to subdivide this section into:
> {code:java}
> - Core components:
> - Domain list
> - DNS
> - Mailet containet
> - MailRepositoryStore
> - RRT
> - Protocols
> - SMTP/LMTP
> - IMAP4
> - POP3
> - FetchMail
> - Sieve
> - Backend specific configuration
> - ElasticSearch
> - Cassandra
> - JPA postgrey
> - Spring specific configuration
> - mailbox
> - events
> - quota
> - Guice specific configuration
> - listeners
> - How to...
> - Anti-Spam
> {code}
> We are also missing config about... Tika, WebAdmin, JMAP, JMX, indexer...
> This new organisation will allow adding them in the corresponding sections.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
