Re: Bundle Documentation: Readme in Bundle Repo vs MD in Site Repo

2017-10-04 Thread Bertrand Delacretaz
On Wed, Oct 4, 2017 at 12:03 PM, Oliver Lietz wrote: > ...I prefer having a good > README or module "site" and only documenting high-level concepts or general > stuff in Sling's site (and wiki)... +1 -Bertrand

Re: Bundle Documentation: Readme in Bundle Repo vs MD in Site Repo

2017-10-04 Thread Oliver Lietz
On Tuesday 03 October 2017 15:50:17 Konrad Windszus wrote: > 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

Re: Bundle Documentation: Readme in Bundle Repo vs MD in Site Repo

2017-10-04 Thread Konrad Windszus
Thanks for the pointers. I created https://issues.apache.org/jira/browse/SLING-7176 to track this. Feel free to extend it with your own ideas. > On 4. Oct 2017, at 11:49, Bertrand Delacretaz wrote: > > Hi, > > On Wed, Oct 4, 2017 at 9:57 AM, Robert Munteanu

Re: Bundle Documentation: Readme in Bundle Repo vs MD in Site Repo

2017-10-04 Thread Robert Munteanu
On Wed, 2017-10-04 at 11:49 +0200, Bertrand Delacretaz wrote: > Hi, > > On Wed, Oct 4, 2017 at 9:57 AM, Robert Munteanu > wrote: > > ...The 'canonical' way of doing this is by accessing https://api.gi > > thub.co > > m/orgs/${github_org}/repos and filtering based on the repo

Re: Bundle Documentation: Readme in Bundle Repo vs MD in Site Repo

2017-10-04 Thread Bertrand Delacretaz
Hi, On Wed, Oct 4, 2017 at 9:57 AM, Robert Munteanu wrote: > ...The 'canonical' way of doing this is by accessing https://api.github.co > m/orgs/${github_org}/repos and filtering based on the repo name... Note that this would require handling multiple pages, it looks like

Re: Bundle Documentation: Readme in Bundle Repo vs MD in Site Repo

2017-10-04 Thread Robert Munteanu
On Wed, 2017-10-04 at 10:01 +0200, Konrad Windszus wrote: > > On 4. Oct 2017, at 09:57, Robert Munteanu > > wrote: > > > > On Tue, 2017-10-03 at 17:03 +0200, Konrad Windszus wrote: > > > > On 3. Oct 2017, at 16:35, Bertrand Delacretaz > > > he.o > > > >

Re: Bundle Documentation: Readme in Bundle Repo vs MD in Site Repo

2017-10-04 Thread Konrad Windszus
> On 4. Oct 2017, at 09:57, Robert Munteanu wrote: > > On Tue, 2017-10-03 at 17:03 +0200, Konrad Windszus wrote: >>> On 3. Oct 2017, at 16:35, Bertrand Delacretaz >> rg> wrote: >>> >>> Hi, >>> >>> On Tue, Oct 3, 2017 at 3:50 PM, Konrad Windszus

Re: Bundle Documentation: Readme in Bundle Repo vs MD in Site Repo

2017-10-04 Thread Robert Munteanu
On Tue, 2017-10-03 at 17:03 +0200, Konrad Windszus wrote: > > On 3. Oct 2017, at 16:35, Bertrand Delacretaz > rg> wrote: > > > > Hi, > > > > On Tue, Oct 3, 2017 at 3:50 PM, Konrad Windszus > > wrote: > > > ...I think we also once discussed on the mailing

Re: Bundle Documentation: Readme in Bundle Repo vs MD in Site Repo

2017-10-03 Thread Bertrand Delacretaz
Hi, On Tue, Oct 3, 2017 at 5:03 PM, Konrad Windszus wrote: > ...The only question would be, when and how to trigger the update... We touch the site regularly, so the list of modules would be kept up to date frequently - and if needed it's easy to regenerate the website when

Re: Bundle Documentation: Readme in Bundle Repo vs MD in Site Repo

2017-10-03 Thread Konrad Windszus
> On 3. Oct 2017, at 16:35, Bertrand Delacretaz wrote: > > Hi, > > On Tue, Oct 3, 2017 at 3:50 PM, Konrad Windszus wrote: >> ...I think we also once discussed on the mailing list where to put bundle >> documentation: either in the readme or in the

Re: Bundle Documentation: Readme in Bundle Repo vs MD in Site Repo

2017-10-03 Thread Robert Munteanu
On Tue, 2017-10-03 at 15:50 +0200, Konrad Windszus wrote: > 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.

Re: Bundle Documentation: Readme in Bundle Repo vs MD in Site Repo

2017-10-03 Thread Bertrand Delacretaz
Hi, On Tue, Oct 3, 2017 at 3:50 PM, Konrad Windszus wrote: > ...I think we also once discussed on the mailing list where to put bundle > documentation: either in the readme or in the site itself... Now that we have complete control over the website we might generate

Bundle Documentation: Readme in Bundle Repo vs MD in Site Repo

2017-10-03 Thread Konrad Windszus
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