Re: Ok to replace sling.apache.org with the new JBake-generated site ?
+1, great job Bertrand! Regards Carsten Julian Sedding wrote > Thanks for the great work Bertrand! That should make contributing > documentation simpler & more transparent. > > Regards > Julian > > On Thu, Sep 28, 2017 at 8:21 PM, Stefan Seifert > wrote: >> great, thanks for all the work! >> >> btw. on github, there is still a remnant oft he sling-sling-site repo: >> https://github.com/apache/sling-sling-site >> >> and can we enable the "dual master" git mode fort he sling-site repo? would >> be a good testcase for use before doing the full migration. >> https://github.com/apache/sling-site >> >> stefan >> >>> -Original Message- >>> From: Bertrand Delacretaz [mailto:bdelacre...@apache.org] >>> Sent: Thursday, September 28, 2017 7:23 PM >>> To: dev >>> Subject: Re: Ok to replace sling.apache.org with the new JBake-generated >>> site ? >>> >>> On Thu, Sep 28, 2017 at 2:42 PM, Bertrand Delacretaz >>> wrote: >>>>> ... I have requested activation of the >>>>> new site, https://issues.apache.org/jira/browse/INFRA-15186 ... >>> >>> The new site is live at http://sling.apache.org , source at >>> https://git-wip-us.apache.org/repos/asf?p=sling-site.git >>> >>> -Bertrand >> -- Carsten Ziegeler Adobe Research Switzerland cziege...@apache.org
Re: Ok to replace sling.apache.org with the new JBake-generated site ?
+1 Thanks for driving this Bertrand! On Fri, Sep 29, 2017 at 12:50 PM Julian Sedding wrote: > Thanks for the great work Bertrand! That should make contributing > documentation simpler & more transparent. > > Regards > Julian > > On Thu, Sep 28, 2017 at 8:21 PM, Stefan Seifert > wrote: > > great, thanks for all the work! > > > > btw. on github, there is still a remnant oft he sling-sling-site repo: > > https://github.com/apache/sling-sling-site > > > > and can we enable the "dual master" git mode fort he sling-site repo? > would be a good testcase for use before doing the full migration. > > https://github.com/apache/sling-site > > > > stefan > > > >>-Original Message- > >>From: Bertrand Delacretaz [mailto:bdelacre...@apache.org] > >>Sent: Thursday, September 28, 2017 7:23 PM > >>To: dev > >>Subject: Re: Ok to replace sling.apache.org with the new JBake-generated > >>site ? > >> > >>On Thu, Sep 28, 2017 at 2:42 PM, Bertrand Delacretaz > >> wrote: > >>>>... I have requested activation of the > >>>> new site, https://issues.apache.org/jira/browse/INFRA-15186 ... > >> > >>The new site is live at http://sling.apache.org , source at > >>https://git-wip-us.apache.org/repos/asf?p=sling-site.git > >> > >>-Bertrand > > >
Re: Ok to replace sling.apache.org with the new JBake-generated site ?
Thanks for the great work Bertrand! That should make contributing documentation simpler & more transparent. Regards Julian On Thu, Sep 28, 2017 at 8:21 PM, Stefan Seifert wrote: > great, thanks for all the work! > > btw. on github, there is still a remnant oft he sling-sling-site repo: > https://github.com/apache/sling-sling-site > > and can we enable the "dual master" git mode fort he sling-site repo? would > be a good testcase for use before doing the full migration. > https://github.com/apache/sling-site > > stefan > >>-Original Message- >>From: Bertrand Delacretaz [mailto:bdelacre...@apache.org] >>Sent: Thursday, September 28, 2017 7:23 PM >>To: dev >>Subject: Re: Ok to replace sling.apache.org with the new JBake-generated >>site ? >> >>On Thu, Sep 28, 2017 at 2:42 PM, Bertrand Delacretaz >> wrote: >>>>... I have requested activation of the >>>> new site, https://issues.apache.org/jira/browse/INFRA-15186 ... >> >>The new site is live at http://sling.apache.org , source at >>https://git-wip-us.apache.org/repos/asf?p=sling-site.git >> >>-Bertrand >
RE: Ok to replace sling.apache.org with the new JBake-generated site ?
great, thanks for all the work! btw. on github, there is still a remnant oft he sling-sling-site repo: https://github.com/apache/sling-sling-site and can we enable the "dual master" git mode fort he sling-site repo? would be a good testcase for use before doing the full migration. https://github.com/apache/sling-site stefan >-Original Message- >From: Bertrand Delacretaz [mailto:bdelacre...@apache.org] >Sent: Thursday, September 28, 2017 7:23 PM >To: dev >Subject: Re: Ok to replace sling.apache.org with the new JBake-generated >site ? > >On Thu, Sep 28, 2017 at 2:42 PM, Bertrand Delacretaz > wrote: >>>... I have requested activation of the >>> new site, https://issues.apache.org/jira/browse/INFRA-15186 ... > >The new site is live at http://sling.apache.org , source at >https://git-wip-us.apache.org/repos/asf?p=sling-site.git > >-Bertrand
Re: Ok to replace sling.apache.org with the new JBake-generated site ?
Although both metadata title as well as every line starting with # generate a h1, but the difference is as follows in the generated HTML. The former doesn’t include an a tag, while the latter does. I guess just including the a tag in the selector helps to not make the title itself appear in the TOC. > Am 28.09.2017 um 19:38 schrieb Konrad Windszus : > > What is the reason why the selector at > https://github.com/apache/sling-site/blob/f7d38e20d4576a37413fb3d31a28060e8dc0ac60/src/main/jbake/templates/page.tpl#L49 > only lists h2 and h3? > >> Am 28.09.2017 um 19:35 schrieb Konrad Windszus : >> >> The TOC e.g. at http://sling.apache.org/documentation/bundles/models.html >> still looks a bit weird. >> It only lists the h2 headlines but not the h1 ones. >> The same at http://sling.apache.org/documentation.html. >> In the best case both are listed in the TOC, with h2 with some indentation. >>> Am 28.09.2017 um 19:23 schrieb Bertrand Delacretaz : >>> >>> On Thu, Sep 28, 2017 at 2:42 PM, Bertrand Delacretaz >>> wrote: > ... I have requested activation of the > new site, https://issues.apache.org/jira/browse/INFRA-15186 ... >>> >>> The new site is live at http://sling.apache.org , source at >>> https://git-wip-us.apache.org/repos/asf?p=sling-site.git >>> >>> -Bertrand >> >
Re: Ok to replace sling.apache.org with the new JBake-generated site ?
What is the reason why the selector at https://github.com/apache/sling-site/blob/f7d38e20d4576a37413fb3d31a28060e8dc0ac60/src/main/jbake/templates/page.tpl#L49 only lists h2 and h3? > Am 28.09.2017 um 19:35 schrieb Konrad Windszus : > > The TOC e.g. at http://sling.apache.org/documentation/bundles/models.html > still looks a bit weird. > It only lists the h2 headlines but not the h1 ones. > The same at http://sling.apache.org/documentation.html. > In the best case both are listed in the TOC, with h2 with some indentation. >> Am 28.09.2017 um 19:23 schrieb Bertrand Delacretaz : >> >> On Thu, Sep 28, 2017 at 2:42 PM, Bertrand Delacretaz >> wrote: ... I have requested activation of the new site, https://issues.apache.org/jira/browse/INFRA-15186 ... >> >> The new site is live at http://sling.apache.org , source at >> https://git-wip-us.apache.org/repos/asf?p=sling-site.git >> >> -Bertrand >
Re: Ok to replace sling.apache.org with the new JBake-generated site ?
The TOC e.g. at http://sling.apache.org/documentation/bundles/models.html still looks a bit weird. It only lists the h2 headlines but not the h1 ones. The same at http://sling.apache.org/documentation.html. In the best case both are listed in the TOC, with h2 with some indentation. > Am 28.09.2017 um 19:23 schrieb Bertrand Delacretaz : > > On Thu, Sep 28, 2017 at 2:42 PM, Bertrand Delacretaz > wrote: >>> ... I have requested activation of the >>> new site, https://issues.apache.org/jira/browse/INFRA-15186 ... > > The new site is live at http://sling.apache.org , source at > https://git-wip-us.apache.org/repos/asf?p=sling-site.git > > -Bertrand
Re: Ok to replace sling.apache.org with the new JBake-generated site ?
On Thu, Sep 28, 2017 at 2:42 PM, Bertrand Delacretaz wrote: >>... I have requested activation of the >> new site, https://issues.apache.org/jira/browse/INFRA-15186 ... The new site is live at http://sling.apache.org , source at https://git-wip-us.apache.org/repos/asf?p=sling-site.git -Bertrand
Re: Ok to replace sling.apache.org with the new JBake-generated site ?
On Thu, Sep 28, 2017 at 2:41 PM, Bertrand Delacretaz wrote: > I have requested activation of the > new site, https://issues.apache.org/jira/browse/INFRA-15186 And when that's done I will resync from the few changes in the current svn content, and update website generation instructions to point to the new stuff. -Bertrand
Re: Ok to replace sling.apache.org with the new JBake-generated site ?
On Tue, Sep 26, 2017 at 5:54 PM, Bertrand Delacretaz wrote: > As discussed earlier I think the SLING-6955 conversion of our website > to JBake is now ready... Thanks everybody for your comments, I have request activation of the new site, https://issues.apache.org/jira/browse/INFRA-15186 -Bertrand
Re: Ok to replace sling.apache.org with the new JBake-generated site ?
Hi, On Wed, Sep 27, 2017 at 11:46 AM, Konrad Windszus wrote: > ..With that stop-gap solution I am +1 on the replacement as > well (although the TOC wouldn't be exposed on the GH mirror)... Ok thanks! I have implemented the toc.js generation based on Robert's idea, for all pages of type "page" under https://sling.apache.org/ng/ This means that for now all pages get a ToC - we might introduce a way to disable it via markdown front matter but I think that's good enough for now. -Bertrand
Re: Ok to replace sling.apache.org with the new JBake-generated site ?
> On 27. Sep 2017, at 11:43, Bertrand Delacretaz wrote: > > On Wed, Sep 27, 2017 at 10:42 AM, Robert Munteanu wrote: >> ... As for the TOC, we can have a stop-gap solution with something like [1] >> until we get proper support in JBake... > > That's a great idea. > > The problem if we wait more to activate the website is that resyncing > to the evolving svn content is painful - the longer we wait the worse > it gets. > > Konrad, would this tocjs option work for you until we get something better? With that stop-gap solution I am +1 on the replacement as well (although the TOC wouldn't be exposed on the GH mirror) > > I totally agree with the need to rework the > https://sling.apache.org/ng/documentation.html#how-the-documentation-is-generated > page. Note however that being able to run the website generation > locally makes it much easier to experiment. Right, we should just make sure that most of the information which is currently on in the readme in https://github.com/apache/sling-site/blob/master/README.md should be either linked or better moved to that section. > > -Bertrand > >> [1]: https://github.com/nghuuphuoc/tocjs
Re: Ok to replace sling.apache.org with the new JBake-generated site ?
On Wed, Sep 27, 2017 at 10:42 AM, Robert Munteanu wrote: >... As for the TOC, we can have a stop-gap solution with something like [1] > until we get proper support in JBake... That's a great idea. The problem if we wait more to activate the website is that resyncing to the evolving svn content is painful - the longer we wait the worse it gets. Konrad, would this tocjs option work for you until we get something better? I totally agree with the need to rework the https://sling.apache.org/ng/documentation.html#how-the-documentation-is-generated page. Note however that being able to run the website generation locally makes it much easier to experiment. -Bertrand > [1]: https://github.com/nghuuphuoc/tocjs
Re: Ok to replace sling.apache.org with the new JBake-generated site ?
We can still generate a TOC manually - see https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/master/SPECIFICATION.md#contents . On Wed, 27 Sep 2017 at 10:49 Carsten Ziegeler wrote: > I see your point with the TOC, the question is should we put the whole > effort on hold because of this? > > I'm leaning more to do the migration now, and one TOC support is there > we can use it. WIthout a TOC still all info is on the side and a search > brings you to the right place. I personally rarely use a TOC, but that > might just be me > > Carsten > > > Konrad Windszus wrote > > I think we should include some hints which markdown format is supposed > to be used. > > Currently I guess it is only > https://daringfireball.net/projects/markdown/syntax but in the future > once flexmark-java is included it is ought to be > http://spec.commonmark.org/0.28/ or whatever version is current and > supported by flexmark-java at that point in time. > > > > The whole section at > https://sling.apache.org/ng/documentation.html#how-the-documentation-is-generated > needs to be extended with at least the following information > > - the exact markdown syntax/spec with references > > - only markdown files should be used > > - how to locally generate the site > > > > For me the TOC limitation though is quite severe, because for larger > pages like http://sling.apache.org/documentation/bundles/models.html the > TOC is kind of crucial. Without it it is hard to find the right information. > > So to be honest I am not sure we should already migrate before the TOC > support has been added. > > It seems that the support for flexmark-java is only supposed to land in > JBake 2.7.0 which is the version after the next version (so rather far away > in the future). > > > > Have you guys considered switching from MD to AsciDoc which already has > native TOC support in JBake. > > Don't know how feasible it is to migrate the existing MD files though... > > > > Konrad > > > > > > > > > >> On 27. Sep 2017, at 10:08, Carsten Ziegeler > wrote: > >> > >> +1 > >> > >> > >> Stefan Seifert wrote > >>> +1 > >>> > >>> small issues that may still be present can be fixed later, i think we > have no showstoppers. > >>> > >>> stefan > >>> > >> -- > >> Carsten Ziegeler > >> Adobe Research Switzerland > >> cziege...@apache.org > > > -- > Carsten Ziegeler > Adobe Research Switzerland > cziege...@apache.org >
Re: Ok to replace sling.apache.org with the new JBake-generated site ?
I see your point with the TOC, the question is should we put the whole effort on hold because of this? I'm leaning more to do the migration now, and one TOC support is there we can use it. WIthout a TOC still all info is on the side and a search brings you to the right place. I personally rarely use a TOC, but that might just be me Carsten Konrad Windszus wrote > I think we should include some hints which markdown format is supposed to be > used. > Currently I guess it is only > https://daringfireball.net/projects/markdown/syntax but in the future once > flexmark-java is included it is ought to be http://spec.commonmark.org/0.28/ > or whatever version is current and supported by flexmark-java at that point > in time. > > The whole section at > https://sling.apache.org/ng/documentation.html#how-the-documentation-is-generated > needs to be extended with at least the following information > - the exact markdown syntax/spec with references > - only markdown files should be used > - how to locally generate the site > > For me the TOC limitation though is quite severe, because for larger pages > like http://sling.apache.org/documentation/bundles/models.html the TOC is > kind of crucial. Without it it is hard to find the right information. > So to be honest I am not sure we should already migrate before the TOC > support has been added. > It seems that the support for flexmark-java is only supposed to land in JBake > 2.7.0 which is the version after the next version (so rather far away in the > future). > > Have you guys considered switching from MD to AsciDoc which already has > native TOC support in JBake. > Don't know how feasible it is to migrate the existing MD files though... > > Konrad > > > > >> On 27. Sep 2017, at 10:08, Carsten Ziegeler wrote: >> >> +1 >> >> >> Stefan Seifert wrote >>> +1 >>> >>> small issues that may still be present can be fixed later, i think we have >>> no showstoppers. >>> >>> stefan >>> >> -- >> Carsten Ziegeler >> Adobe Research Switzerland >> cziege...@apache.org > -- Carsten Ziegeler Adobe Research Switzerland cziege...@apache.org
Re: Ok to replace sling.apache.org with the new JBake-generated site ?
On Wed, 2017-09-27 at 10:33 +0200, Konrad Windszus wrote: > I think we should include some hints which markdown format is > supposed to be used. > Currently I guess it is only https://daringfireball.net/projects/mark > down/syntax but in the future once flexmark-java is included it is > ought to be http://spec.commonmark.org/0.28/ or whatever version is > current and supported by flexmark-java at that point in time. > > The whole section at https://sling.apache.org/ng/documentation.html#h > ow-the-documentation-is-generated needs to be extended with at least > the following information > - the exact markdown syntax/spec with references > - only markdown files should be used > - how to locally generate the site > > For me the TOC limitation though is quite severe, because for larger > pages like http://sling.apache.org/documentation/bundles/models.html > the TOC is kind of crucial. Without it it is hard to find the right > information. > So to be honest I am not sure we should already migrate before the > TOC support has been added. > It seems that the support for flexmark-java is only supposed to land > in JBake 2.7.0 which is the version after the next version (so rather > far away in the future). My personal opinion is that migrating to git and away from the ASF CMS is already a win, since it becomes much easier to control the overall behaviour of the website. As for the TOC, we can have a stop-gap solution with something like [1] until we get proper support in JBake. > Have you guys considered switching from MD to AsciDoc which already > has native TOC support in JBake. > Don't know how feasible it is to migrate the existing MD files > though... I think that would be another big project, if we decide to do that. It already is quite involved to keep the two systems in sync, adding a conversion step in the meantime would make it even harder. Thanks, Robret [1]: https://github.com/nghuuphuoc/tocjs > Konrad > > > > > > On 27. Sep 2017, at 10:08, Carsten Ziegeler > > wrote: > > > > +1 > > > > > > Stefan Seifert wrote > > > +1 > > > > > > small issues that may still be present can be fixed later, i > > > think we have no showstoppers. > > > > > > stefan > > > > > > > -- > > Carsten Ziegeler > > Adobe Research Switzerland > > cziege...@apache.org > >
Re: Ok to replace sling.apache.org with the new JBake-generated site ?
I think we should include some hints which markdown format is supposed to be used. Currently I guess it is only https://daringfireball.net/projects/markdown/syntax but in the future once flexmark-java is included it is ought to be http://spec.commonmark.org/0.28/ or whatever version is current and supported by flexmark-java at that point in time. The whole section at https://sling.apache.org/ng/documentation.html#how-the-documentation-is-generated needs to be extended with at least the following information - the exact markdown syntax/spec with references - only markdown files should be used - how to locally generate the site For me the TOC limitation though is quite severe, because for larger pages like http://sling.apache.org/documentation/bundles/models.html the TOC is kind of crucial. Without it it is hard to find the right information. So to be honest I am not sure we should already migrate before the TOC support has been added. It seems that the support for flexmark-java is only supposed to land in JBake 2.7.0 which is the version after the next version (so rather far away in the future). Have you guys considered switching from MD to AsciDoc which already has native TOC support in JBake. Don't know how feasible it is to migrate the existing MD files though... Konrad > On 27. Sep 2017, at 10:08, Carsten Ziegeler wrote: > > +1 > > > Stefan Seifert wrote >> +1 >> >> small issues that may still be present can be fixed later, i think we have >> no showstoppers. >> >> stefan >> > -- > Carsten Ziegeler > Adobe Research Switzerland > cziege...@apache.org
Re: Ok to replace sling.apache.org with the new JBake-generated site ?
+1 Stefan Seifert wrote > +1 > > small issues that may still be present can be fixed later, i think we have no > showstoppers. > > stefan > -- Carsten Ziegeler Adobe Research Switzerland cziege...@apache.org
Re: Ok to replace sling.apache.org with the new JBake-generated site ?
+1 regards, Karl On Tuesday, September 26, 2017, Stefan Seifert wrote: > +1 > > small issues that may still be present can be fixed later, i think we have > no showstoppers. > > stefan > -- Karl Pauls karlpa...@gmail.com
RE: Ok to replace sling.apache.org with the new JBake-generated site ?
+1 small issues that may still be present can be fixed later, i think we have no showstoppers. stefan
Re: Ok to replace sling.apache.org with the new JBake-generated site ?
Hi, On Tue, 2017-09-26 at 17:54 +0200, Bertrand Delacretaz wrote: > Is anyone opposed to putting this online instead of the current > http://sling.apache.org// site? Not me, I'd like to see this live sooner rather than later. And the first step towards moving everything to Git :-) Robert
Re: Ok to replace sling.apache.org with the new JBake-generated site ?
Hi Bertrand, at first glance it looks good. Thanks for the effort. But there are some glitches in the source code highlighting as mentioned in https://issues.apache.org/jira/browse/SLING-6955?focusedCommentId=16180873&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-16180873. Some snippets have colouring and others not. Do you happen to know why that is the case and how to fix it? Thanks, Konrad > On 26. Sep 2017, at 17:54, Bertrand Delacretaz wrote: > > Hi, > > As discussed earlier I think the SLING-6955 conversion of our website > to JBake is now ready. I have just resynced the content to svn > revision 1809724 (and will resync when putting it live). > > Is anyone opposed to putting this online instead of the current > http://sling.apache.org/ site? > > There should be no material content differences except the two items > listed as "nice to have" at https://github.com/apache/sling-site > > Testing instructions are found below. > > I'll ask infra to activate this new site later this week unless > someone's opposed. > > -Bertrand > > *** > Testing instructions: > The converted website is ready for review at https://sling.apache.org/ng/ > > Note that links within pages might lead to sling.apache.org instead of > this /ng/ variant as they are absolute and I couldn't get a test > website on / > > However links from the left menu as well as from > https://sling.apache.org/ng/sitemap.html are correct, and the download > page (which uses a CGI script from apache.org) looks good at > https://sling.apache.org/ng/downloads.cgi > > You can also test the website locally (see > https://github.com/apache/sling-site ) where all links will work (but > not the download page which requires apache.org cgi) > > The README has instructions for editing and publishing. > ***
