La 31.07.2020 03:13, David Leangen a scris:
I've decided to add docs stubs to all repositories.
I'm going to start migrating the documentation for the popular libraries and
then decide what to do with the others (start the retiring process most likely).
Awesome! Nice initiative. Thanks!!
Anyone up for a documentation migration party?
As I mentioned before, I am quite skeptical of just migrating documents. I
won’t stop you, but I’m not sure it would add value, because I think the sites
need to be rewritten from scratch. So taking the sources from where they are
now would be just fine IMO.
Migrating is not sexy work but is easier than writing new documentation.
It's also faster and it gives us a chance to know what we have and check
the documentation.
There are things that need to me documented that are not technical:
- what / where are the project resources (website, CI, git repos,
mailing list)
- how to contribute, engage with the community
- etc.
I've added edit-url capabilites, changed the homepage to be in
james-site and renamed main to james-project
.https://james.staged.apache.org/jdkim/0.3-SNAPSHOT/index.html .
By the way David, you can edit the documentation homepage
https://james.staged.apache.org/ to add description about the modules.
My next goals are
- add text to encourage people to contribute to the docs (edit pages)
- figure out what to do with the top menu (Home, products, Services,
etc). =>>> Help needed
- test-migrate a small library (jdkim / jspf ?!)
I'm curios how the structure is going to evolve.
--
Eugen Stan
+40720 898 747 / netdava.com
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
