rbowen opened a new pull request, #317:
URL: https://github.com/apache/incubator-ponymail-foal/pull/317
This PR adds a complete set of documentation for PonyMail Foal,
addressing the long-standing gap between the project's capabilities
and what's written down for users, operators, and developers.
New docs:
- docs/index.md: Documentation hub linking all guides.
- docs/installing.md: Step-by-step installation guide using OpenSearch,
verified against tools/setup.py. Covers OS packages, Python deps,
index creation, mbox import, systemd service, httpd proxy, Postfix
archiving, and troubleshooting.
- docs/architecture.md: Component diagram, data model (mbox/source
indices, threading), plugin system, and request lifecycle.
- docs/operator_guide.md: Docker quickstart and production deployment
paths, consolidated from INSTALL.md + DOCKER.md + server/README.md.
- docs/user_guide.md: End-user guide for browsing, searching, OAuth
login, and composing replies.
- docs/admin_guide.md: Management console, GDPR delete/hide, audit
log, bulk-edit, and re-threading operations.
- docs/plugins.md: How to write new API endpoints and extend the
server and tools plugin systems.
- docs/api_client_guide.md: Practical curl examples for all common
API operations (search, fetch email/thread/source, mbox download),
showing both .json (POST) and .lua (GET) modes.
- docs/releases.md: How versioning works, how to identify the deployed
version, and current release status. Closes #297.
Also:
- AGENTS.md: Guidance for AI coding agents (repo layout, conventions,
tech stack, common pitfalls).
- README.md: Updated with Documentation section linking to docs/.
The user_guide and admin_guide are based on source code reading and
may benefit from refinement once validated against a running instance.
All other docs are verified against the codebase.
TODO: These docs are markdown in-repo. A future step would be to pick
a static site generator (mkdocs or similar) to render them as a proper
website at ponymail.apache.org, replacing the outdated
incubator-ponymail-site content.
Closes #297
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
