[
https://issues.apache.org/jira/browse/SLING-7176?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16191091#comment-16191091
]
Robert Munteanu commented on SLING-7176:
----------------------------------------
Absolutely, we should still publish the generated README files in the
repository. We just script them for consistency, e.g. when adding Jenkins CI
build badges for javadoc.io links this is much much faster.
> Link and embed bundle readme's from Sling Site
> ----------------------------------------------
>
> Key: SLING-7176
> URL: https://issues.apache.org/jira/browse/SLING-7176
> Project: Sling
> Issue Type: Improvement
> Components: Site
> Reporter: Konrad Windszus
>
> As proposed in
> https://lists.apache.org/thread.html/7cb85c44d3b852fd13acc66413606d1ada1e6585eda2220981ad0c6d@%3Cdev.sling.apache.org%3E
> we should link
> # from the bundle's readme MD files to the according page below
> http://sling.apache.org/documentation/bundles.html
> # from the [bundles overview
> page|http://sling.apache.org/documentation/bundles.html] in the Sling Site
> towards the individual bundle's readmes
> The latter should be done automatically by leveraging JBake template
> functionionality.
> Some technical hints on how to implement this:
> # Come up with a new JBake template: bundles
> # This template will use the Github API with its [List organization
> repositories
> method|https://developer.github.com/v3/repos/#list-organization-repositories]
> to figure out all Sling repositories
> # For all repositories containing a readme.md file a link towards this file
> (on Github) should be placed in the bundle overview page
> # To figure out the relation between individual Sling Site Bundle
> Documentation pages (e.g.
> http://sling.apache.org/documentation/bundles/models.html) and the according
> readme.md, the readme should be optionally extended with a link towards the
> Sling Site page.
> # TBD: format of the link towards the Sling Site documentation, so that it
> can be easily extracted with Groovy to put the link to the readme in the
> right position of the bundle overview page.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
