I think we also once discussed on the mailing list where to put bundle 
documentation: either in the readme or in the site itself. Unfortunately I 
couldn't find the according thread. Please help me with the link if you have it 
handy.

Right now the information is a bit distributed and most of the readme's only 
contained a minimally adjusted template and most of the information from a 
consumer's perspective can be found MD pages below 
https://sling.apache.org/documentation/bundles.html. How do we want to proceed 
in the future?

# Put the bundle-specific information rather in the readme to make it easier to 
adjust together with the code (in one common PR)
# Keep maintaining a dedicated MD page in the site repository (to make it 
easier to cross-link to other pages, probably also better from SEO perspective)

And the other question is how do we properly cross-link from one to the other. 
At least for option 1 I would like to put a link in 
https://sling.apache.org/documentation/bundles.html to the individual readme 
files.
Since right now we are updating all readme files I think we should include this 
aspect as well.

Once we have an agreement we should document that in 
https://sling.apache.org/documentation.html.

Thanks for your opinions
Konrad

Reply via email to