Hello,

While working on the documentation website I ran into the question of: What parts to document?

1. What are the repositories we still use in James - some like jdkim have merged in james-project - others ?

2. Which ones we don't use?

3. Which projects we wish to retire - if any? My suggestion: hupa, but we need to make a call and see if anyone steps in?


Current list of repositories: https://gitbox.apache.org/repos/asf#james

james-hupa.git <https://gitbox.apache.org/repos/asf/james-hupa.git> Apache James Hupa 23 weeks ago james-jdkim.git <https://gitbox.apache.org/repos/asf/james-jdkim.git> Apache James jdkim 42 weeks ago james-jsieve.git <https://gitbox.apache.org/repos/asf/james-jsieve.git> Apache James jsieve 42 weeks ago james-jspf.git <https://gitbox.apache.org/repos/asf/james-jspf.git> Apache James jspf 42 weeks ago james-mime4j.git <https://gitbox.apache.org/repos/asf/james-mime4j.git> Apache James mime4j 3 days ago james-postage.git <https://gitbox.apache.org/repos/asf/james-postage.git> Apache James postage 75 weeks ago james-project.git <https://gitbox.apache.org/repos/asf/james-project.git> Apache James project 3 days ago james-site.git <https://gitbox.apache.org/repos/asf/james-site.git> Apache James Website <30 minutes ago


== More context

Antora has a nice system - called [component-version] - that allows us to keep the documentation next to the sources and have multiple version of it.

Right now we have this setup with only James project - https://github.com/apache/james-site/blob/live/doc-sites/antora-playbook.yml

I do believe we should keep the documentation in every project and publish them as components.

We can add edit links back to github for each page.

I'll create a component-version for each project and try to migrate as much documentation as I can (help needed).

The website should be published from james-site which IMO should also contain the Jekyll content.


[component-version] https://docs.antora.org/antora/2.3/component-version/

--
Eugen Stan
+40720 898 747 / netdava.com


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to