Re: News on front page about new website and documentation
Hi Claus Thanks for the heads up. I did some fix of the format issues of the wiki pages. I just realize they are supposed to be read only now. I know we will create a new website for those components , but it looks like there are lots of wiki pages are not ported. Do we have any plan for it? Willem Jiang Blog: http://willemjiang.blogspot.com (English) http://jnn.iteye.com (Chinese) Twitter: willemjiang Weibo: 姜宁willem On Tue, May 15, 2018 at 4:01 PM, Claus Ibsen wrote: > Hi Willem > > Just a heads-up that component documents in the wiki is to be > considered deprecated and in read-only mode. > The correct place for component documentations is in the source code > with those ascii doc files in the src/main/docs folder. > > So if you do any WIKI edits then they are LOST!!! > > > > > On Tue, May 8, 2018 at 12:46 AM, Willem Jiang > wrote: > > Hi Zoran, > > > > Thanks for the information, I will play with it when I get some time. > > > > BTW, there are some formate issues[1] about showing the code snippet in > the > > current website, do we have any plan for fixing these kind of issue? > > > > [1]http://camel.apache.org/spring.html > > > > > > Willem Jiang > > > > Blog: http://willemjiang.blogspot.com (English) > > http://jnn.iteye.com (Chinese) > > Twitter: willemjiang > > Weibo: 姜宁willem > > > > On Mon, May 7, 2018 at 4:48 PM, Zoran Regvart wrote: > > > >> Hi Willem, > >> I started a `website` branch a while back, and there is a README.md[1] > >> there that has some information. That being said I'm experimenting > >> with transitioning to JBake as it seems to have better support for > >> Asciidoc and this might change, I'll keep that README up to date > >> though. > >> > >> If you're asking about how the current website is built, from what > >> I've understood there is a build job that's triggered when the > >> Confluence WIKI is updated and runs `build_cms.sh`[2], there is a > >> README[3] in the SVN repository there, the job (I guess, I've never > >> seen the job configuration) then copies the output to a directory > >> served by as camel.apache.org. > >> > >> Hope this helps, > >> > >> zoran > >> > >> [1] https://github.com/apache/camel/blob/website/camel- > website/README.md > >> [2] https://svn.apache.org/repos/asf/camel/website/ > >> [3] https://svn.apache.org/repos/asf/camel/website/README > >> > >> On Sat, May 5, 2018 at 2:08 AM, Willem Jiang > >> wrote: > >> > Hi, > >> > > >> > Is there a brief introduction of the current camel document building > >> > processing? > >> > I just found there are some maven plugins which can generate the > document > >> > there. > >> > > >> > > >> > Willem Jiang > >> > > >> > Blog: http://willemjiang.blogspot.com (English) > >> > http://jnn.iteye.com (Chinese) > >> > Twitter: willemjiang > >> > Weibo: 姜宁willem > >> > > >> > On Thu, Apr 26, 2018 at 4:11 PM, Willem Jiang > > >> > wrote: > >> > > >> >> oh, my bad. > >> >> The URL that I want to share is. > >> >> > >> >> https://github.com/apache/incubator-servicecomb-website > >> >> > >> >> > >> >> Willem Jiang > >> >> > >> >> Blog: http://willemjiang.blogspot.com (English) > >> >> http://jnn.iteye.com (Chinese) > >> >> Twitter: willemjiang > >> >> Weibo: 姜宁willem > >> >> > >> >> On Thu, Apr 26, 2018 at 2:33 AM, Claus Ibsen > >> >> wrote: > >> >> > >> >>> Hi Willem > >> >>> > >> >>> Great to hear you got some experience with building a website with > >> >>> markdown content. > >> >>> We are using ascii doc but it should be similar. > >> >>> > >> >>> If you wanted to refer to a link in [1] then I dont see that in your > >> >>> email. > >> >>> > >> >>> > >> >>> On Wed, Apr 25, 2018 at 6:45 PM, Willem Jiang < > willem.ji...@gmail.com> > >> >>> wrote: > >> >>> > +1 for bring a new website. > >> >>> > > >> >>> > Normally, there are some building blocks project in the github for > >> the > >> >>> > personal website. > >> >>> > Last year we built a new website[1] for the ServiceComb project by > >> using > >> >>> > markdown as the content. > >> >>> > Maybe we can do the same thing for the new camel website. > >> >>> > > >> >>> > Any thoughts? > >> >>> > > >> >>> > > >> >>> > Willem Jiang > >> >>> > > >> >>> > Blog: http://willemjiang.blogspot.com (English) > >> >>> > http://jnn.iteye.com (Chinese) > >> >>> > Twitter: willemjiang > >> >>> > Weibo: 姜宁willem > >> >>> > > >> >>> > On Mon, Mar 26, 2018 at 5:12 PM, Claus Ibsen < > claus.ib...@gmail.com> > >> >>> wrote: > >> >>> > > >> >>> >> Hi > >> >>> >> > >> >>> >> I have created a new draft to post on the Camel front page. > >> >>> >> > >> >>> >> Any comments and feedback? > >> >>> >> > >> >>> >> > >> >>> >> > >> >>> >> > >> >>> >> Update on the Apache Camel website and documentation > >> >>> >> > >> >>> >> > >> >>> >> The current Apache Camel website and documentation is currently > >> >>> undergoing > >> >>> >> work to be rewamped and updated for a modern webs
Re: News on front page about new website and documentation
Hi Willem Just a heads-up that component documents in the wiki is to be considered deprecated and in read-only mode. The correct place for component documentations is in the source code with those ascii doc files in the src/main/docs folder. So if you do any WIKI edits then they are LOST!!! On Tue, May 8, 2018 at 12:46 AM, Willem Jiang wrote: > Hi Zoran, > > Thanks for the information, I will play with it when I get some time. > > BTW, there are some formate issues[1] about showing the code snippet in the > current website, do we have any plan for fixing these kind of issue? > > [1]http://camel.apache.org/spring.html > > > Willem Jiang > > Blog: http://willemjiang.blogspot.com (English) > http://jnn.iteye.com (Chinese) > Twitter: willemjiang > Weibo: 姜宁willem > > On Mon, May 7, 2018 at 4:48 PM, Zoran Regvart wrote: > >> Hi Willem, >> I started a `website` branch a while back, and there is a README.md[1] >> there that has some information. That being said I'm experimenting >> with transitioning to JBake as it seems to have better support for >> Asciidoc and this might change, I'll keep that README up to date >> though. >> >> If you're asking about how the current website is built, from what >> I've understood there is a build job that's triggered when the >> Confluence WIKI is updated and runs `build_cms.sh`[2], there is a >> README[3] in the SVN repository there, the job (I guess, I've never >> seen the job configuration) then copies the output to a directory >> served by as camel.apache.org. >> >> Hope this helps, >> >> zoran >> >> [1] https://github.com/apache/camel/blob/website/camel-website/README.md >> [2] https://svn.apache.org/repos/asf/camel/website/ >> [3] https://svn.apache.org/repos/asf/camel/website/README >> >> On Sat, May 5, 2018 at 2:08 AM, Willem Jiang >> wrote: >> > Hi, >> > >> > Is there a brief introduction of the current camel document building >> > processing? >> > I just found there are some maven plugins which can generate the document >> > there. >> > >> > >> > Willem Jiang >> > >> > Blog: http://willemjiang.blogspot.com (English) >> > http://jnn.iteye.com (Chinese) >> > Twitter: willemjiang >> > Weibo: 姜宁willem >> > >> > On Thu, Apr 26, 2018 at 4:11 PM, Willem Jiang >> > wrote: >> > >> >> oh, my bad. >> >> The URL that I want to share is. >> >> >> >> https://github.com/apache/incubator-servicecomb-website >> >> >> >> >> >> Willem Jiang >> >> >> >> Blog: http://willemjiang.blogspot.com (English) >> >> http://jnn.iteye.com (Chinese) >> >> Twitter: willemjiang >> >> Weibo: 姜宁willem >> >> >> >> On Thu, Apr 26, 2018 at 2:33 AM, Claus Ibsen >> >> wrote: >> >> >> >>> Hi Willem >> >>> >> >>> Great to hear you got some experience with building a website with >> >>> markdown content. >> >>> We are using ascii doc but it should be similar. >> >>> >> >>> If you wanted to refer to a link in [1] then I dont see that in your >> >>> email. >> >>> >> >>> >> >>> On Wed, Apr 25, 2018 at 6:45 PM, Willem Jiang >> >>> wrote: >> >>> > +1 for bring a new website. >> >>> > >> >>> > Normally, there are some building blocks project in the github for >> the >> >>> > personal website. >> >>> > Last year we built a new website[1] for the ServiceComb project by >> using >> >>> > markdown as the content. >> >>> > Maybe we can do the same thing for the new camel website. >> >>> > >> >>> > Any thoughts? >> >>> > >> >>> > >> >>> > Willem Jiang >> >>> > >> >>> > Blog: http://willemjiang.blogspot.com (English) >> >>> > http://jnn.iteye.com (Chinese) >> >>> > Twitter: willemjiang >> >>> > Weibo: 姜宁willem >> >>> > >> >>> > On Mon, Mar 26, 2018 at 5:12 PM, Claus Ibsen >> >>> wrote: >> >>> > >> >>> >> Hi >> >>> >> >> >>> >> I have created a new draft to post on the Camel front page. >> >>> >> >> >>> >> Any comments and feedback? >> >>> >> >> >>> >> >> >>> >> >> >>> >> >> >>> >> Update on the Apache Camel website and documentation >> >>> >> >> >>> >> >> >>> >> The current Apache Camel website and documentation is currently >> >>> undergoing >> >>> >> work to be rewamped and updated for a modern website. >> >>> >> >> >>> >> This work has been underway for a longer time. We kicked off the >> work >> >>> by >> >>> >> migrating the documentation of every Camel component from the wiki >> >>> system >> >>> >> to the source code as ascii doc files. This allowed us during the >> build >> >>> >> of the Apache Camel project to automatic keep parts of the >> >>> documentation >> >>> >> up-to-date with the source code, such as when new options is added >> to >> >>> >> components. >> >>> >> We then moved on migrate all the data formats, languages, and the >> EIP >> >>> >> patterns. >> >>> >> >> >>> >> This has been substantional work, as if you were to print all the >> >>> >> Camel documentation >> >>> >> then it would be more than 3000 sheets of papers. >> >>> >> >> >>> >> At this point of time, we are about to draft up a ne
Re: News on front page about new website and documentation
Hi Willem, those issues and the docs getting out of date were the reasons we put up the notice at the top and focusing, albeit not that effectively, at the new website effort. I vaguely remember someone on Gitter offering a JavaScript snippet to fix that issue. I guess we could fix it by fiddling with the template in SVN, but this whole process with the old website is a bit of black magic to me. zoran On Tue, May 8, 2018 at 12:46 AM, Willem Jiang wrote: > Hi Zoran, > > Thanks for the information, I will play with it when I get some time. > > BTW, there are some formate issues[1] about showing the code snippet in the > current website, do we have any plan for fixing these kind of issue? > > [1]http://camel.apache.org/spring.html -- Zoran Regvart
Re: News on front page about new website and documentation
Hi Zoran, Thanks for the information, I will play with it when I get some time. BTW, there are some formate issues[1] about showing the code snippet in the current website, do we have any plan for fixing these kind of issue? [1]http://camel.apache.org/spring.html Willem Jiang Blog: http://willemjiang.blogspot.com (English) http://jnn.iteye.com (Chinese) Twitter: willemjiang Weibo: 姜宁willem On Mon, May 7, 2018 at 4:48 PM, Zoran Regvart wrote: > Hi Willem, > I started a `website` branch a while back, and there is a README.md[1] > there that has some information. That being said I'm experimenting > with transitioning to JBake as it seems to have better support for > Asciidoc and this might change, I'll keep that README up to date > though. > > If you're asking about how the current website is built, from what > I've understood there is a build job that's triggered when the > Confluence WIKI is updated and runs `build_cms.sh`[2], there is a > README[3] in the SVN repository there, the job (I guess, I've never > seen the job configuration) then copies the output to a directory > served by as camel.apache.org. > > Hope this helps, > > zoran > > [1] https://github.com/apache/camel/blob/website/camel-website/README.md > [2] https://svn.apache.org/repos/asf/camel/website/ > [3] https://svn.apache.org/repos/asf/camel/website/README > > On Sat, May 5, 2018 at 2:08 AM, Willem Jiang > wrote: > > Hi, > > > > Is there a brief introduction of the current camel document building > > processing? > > I just found there are some maven plugins which can generate the document > > there. > > > > > > Willem Jiang > > > > Blog: http://willemjiang.blogspot.com (English) > > http://jnn.iteye.com (Chinese) > > Twitter: willemjiang > > Weibo: 姜宁willem > > > > On Thu, Apr 26, 2018 at 4:11 PM, Willem Jiang > > wrote: > > > >> oh, my bad. > >> The URL that I want to share is. > >> > >> https://github.com/apache/incubator-servicecomb-website > >> > >> > >> Willem Jiang > >> > >> Blog: http://willemjiang.blogspot.com (English) > >> http://jnn.iteye.com (Chinese) > >> Twitter: willemjiang > >> Weibo: 姜宁willem > >> > >> On Thu, Apr 26, 2018 at 2:33 AM, Claus Ibsen > >> wrote: > >> > >>> Hi Willem > >>> > >>> Great to hear you got some experience with building a website with > >>> markdown content. > >>> We are using ascii doc but it should be similar. > >>> > >>> If you wanted to refer to a link in [1] then I dont see that in your > >>> email. > >>> > >>> > >>> On Wed, Apr 25, 2018 at 6:45 PM, Willem Jiang > >>> wrote: > >>> > +1 for bring a new website. > >>> > > >>> > Normally, there are some building blocks project in the github for > the > >>> > personal website. > >>> > Last year we built a new website[1] for the ServiceComb project by > using > >>> > markdown as the content. > >>> > Maybe we can do the same thing for the new camel website. > >>> > > >>> > Any thoughts? > >>> > > >>> > > >>> > Willem Jiang > >>> > > >>> > Blog: http://willemjiang.blogspot.com (English) > >>> > http://jnn.iteye.com (Chinese) > >>> > Twitter: willemjiang > >>> > Weibo: 姜宁willem > >>> > > >>> > On Mon, Mar 26, 2018 at 5:12 PM, Claus Ibsen > >>> wrote: > >>> > > >>> >> Hi > >>> >> > >>> >> I have created a new draft to post on the Camel front page. > >>> >> > >>> >> Any comments and feedback? > >>> >> > >>> >> > >>> >> > >>> >> > >>> >> Update on the Apache Camel website and documentation > >>> >> > >>> >> > >>> >> The current Apache Camel website and documentation is currently > >>> undergoing > >>> >> work to be rewamped and updated for a modern website. > >>> >> > >>> >> This work has been underway for a longer time. We kicked off the > work > >>> by > >>> >> migrating the documentation of every Camel component from the wiki > >>> system > >>> >> to the source code as ascii doc files. This allowed us during the > build > >>> >> of the Apache Camel project to automatic keep parts of the > >>> documentation > >>> >> up-to-date with the source code, such as when new options is added > to > >>> >> components. > >>> >> We then moved on migrate all the data formats, languages, and the > EIP > >>> >> patterns. > >>> >> > >>> >> This has been substantional work, as if you were to print all the > >>> >> Camel documentation > >>> >> then it would be more than 3000 sheets of papers. > >>> >> > >>> >> At this point of time, we are about to draft up a new table of > content > >>> >> (TOC) for the > >>> >> new Apache Camel documentation and user guide. With the new TOC we > >>> >> will then re-work > >>> >> all the user guide documentation to be updated and focus on modern > >>> >> developer with Camel. > >>> >> In doing so we will grab the good parts of the existing (older) > >>> >> documentation, and in > >>> >> places needed, we will rewrite the documentation. > >>> >> > >>> >> The new website and documentation has a new build system that is > also > >>>
Re: News on front page about new website and documentation
Hi Willem, I started a `website` branch a while back, and there is a README.md[1] there that has some information. That being said I'm experimenting with transitioning to JBake as it seems to have better support for Asciidoc and this might change, I'll keep that README up to date though. If you're asking about how the current website is built, from what I've understood there is a build job that's triggered when the Confluence WIKI is updated and runs `build_cms.sh`[2], there is a README[3] in the SVN repository there, the job (I guess, I've never seen the job configuration) then copies the output to a directory served by as camel.apache.org. Hope this helps, zoran [1] https://github.com/apache/camel/blob/website/camel-website/README.md [2] https://svn.apache.org/repos/asf/camel/website/ [3] https://svn.apache.org/repos/asf/camel/website/README On Sat, May 5, 2018 at 2:08 AM, Willem Jiang wrote: > Hi, > > Is there a brief introduction of the current camel document building > processing? > I just found there are some maven plugins which can generate the document > there. > > > Willem Jiang > > Blog: http://willemjiang.blogspot.com (English) > http://jnn.iteye.com (Chinese) > Twitter: willemjiang > Weibo: 姜宁willem > > On Thu, Apr 26, 2018 at 4:11 PM, Willem Jiang > wrote: > >> oh, my bad. >> The URL that I want to share is. >> >> https://github.com/apache/incubator-servicecomb-website >> >> >> Willem Jiang >> >> Blog: http://willemjiang.blogspot.com (English) >> http://jnn.iteye.com (Chinese) >> Twitter: willemjiang >> Weibo: 姜宁willem >> >> On Thu, Apr 26, 2018 at 2:33 AM, Claus Ibsen >> wrote: >> >>> Hi Willem >>> >>> Great to hear you got some experience with building a website with >>> markdown content. >>> We are using ascii doc but it should be similar. >>> >>> If you wanted to refer to a link in [1] then I dont see that in your >>> email. >>> >>> >>> On Wed, Apr 25, 2018 at 6:45 PM, Willem Jiang >>> wrote: >>> > +1 for bring a new website. >>> > >>> > Normally, there are some building blocks project in the github for the >>> > personal website. >>> > Last year we built a new website[1] for the ServiceComb project by using >>> > markdown as the content. >>> > Maybe we can do the same thing for the new camel website. >>> > >>> > Any thoughts? >>> > >>> > >>> > Willem Jiang >>> > >>> > Blog: http://willemjiang.blogspot.com (English) >>> > http://jnn.iteye.com (Chinese) >>> > Twitter: willemjiang >>> > Weibo: 姜宁willem >>> > >>> > On Mon, Mar 26, 2018 at 5:12 PM, Claus Ibsen >>> wrote: >>> > >>> >> Hi >>> >> >>> >> I have created a new draft to post on the Camel front page. >>> >> >>> >> Any comments and feedback? >>> >> >>> >> >>> >> >>> >> >>> >> Update on the Apache Camel website and documentation >>> >> >>> >> >>> >> The current Apache Camel website and documentation is currently >>> undergoing >>> >> work to be rewamped and updated for a modern website. >>> >> >>> >> This work has been underway for a longer time. We kicked off the work >>> by >>> >> migrating the documentation of every Camel component from the wiki >>> system >>> >> to the source code as ascii doc files. This allowed us during the build >>> >> of the Apache Camel project to automatic keep parts of the >>> documentation >>> >> up-to-date with the source code, such as when new options is added to >>> >> components. >>> >> We then moved on migrate all the data formats, languages, and the EIP >>> >> patterns. >>> >> >>> >> This has been substantional work, as if you were to print all the >>> >> Camel documentation >>> >> then it would be more than 3000 sheets of papers. >>> >> >>> >> At this point of time, we are about to draft up a new table of content >>> >> (TOC) for the >>> >> new Apache Camel documentation and user guide. With the new TOC we >>> >> will then re-work >>> >> all the user guide documentation to be updated and focus on modern >>> >> developer with Camel. >>> >> In doing so we will grab the good parts of the existing (older) >>> >> documentation, and in >>> >> places needed, we will rewrite the documentation. >>> >> >>> >> The new website and documentation has a new build system that is also >>> >> worked. When this >>> >> system is ready we will have a new staging URL where we will regularly >>> >> publish the content, >>> >> so users can follow the progress. >>> >> >>> >> Because the new documentation will be in the source code and in ascii >>> >> doc format, then its >>> >> easier for Camel users to contrbute and help - you can simply just >>> >> submit patches as GitHub PRs. >>> >> >>> >> Have patience with us, as it may take a couple of months for us to be >>> >> ready to publish the staging URL. >>> >> >>> >> We anticipate to have a new website and documentation ready after the >>> >> summer break of 2018. >>> >> >>> >> On Tue, Mar 6, 2018 at 10:48 AM, Claus Ibsen >>> >> wrote: >>> >> > Hi >>> >> > >>> >> > I think we sho
Re: News on front page about new website and documentation
Hi, Is there a brief introduction of the current camel document building processing? I just found there are some maven plugins which can generate the document there. Willem Jiang Blog: http://willemjiang.blogspot.com (English) http://jnn.iteye.com (Chinese) Twitter: willemjiang Weibo: 姜宁willem On Thu, Apr 26, 2018 at 4:11 PM, Willem Jiang wrote: > oh, my bad. > The URL that I want to share is. > > https://github.com/apache/incubator-servicecomb-website > > > Willem Jiang > > Blog: http://willemjiang.blogspot.com (English) > http://jnn.iteye.com (Chinese) > Twitter: willemjiang > Weibo: 姜宁willem > > On Thu, Apr 26, 2018 at 2:33 AM, Claus Ibsen > wrote: > >> Hi Willem >> >> Great to hear you got some experience with building a website with >> markdown content. >> We are using ascii doc but it should be similar. >> >> If you wanted to refer to a link in [1] then I dont see that in your >> email. >> >> >> On Wed, Apr 25, 2018 at 6:45 PM, Willem Jiang >> wrote: >> > +1 for bring a new website. >> > >> > Normally, there are some building blocks project in the github for the >> > personal website. >> > Last year we built a new website[1] for the ServiceComb project by using >> > markdown as the content. >> > Maybe we can do the same thing for the new camel website. >> > >> > Any thoughts? >> > >> > >> > Willem Jiang >> > >> > Blog: http://willemjiang.blogspot.com (English) >> > http://jnn.iteye.com (Chinese) >> > Twitter: willemjiang >> > Weibo: 姜宁willem >> > >> > On Mon, Mar 26, 2018 at 5:12 PM, Claus Ibsen >> wrote: >> > >> >> Hi >> >> >> >> I have created a new draft to post on the Camel front page. >> >> >> >> Any comments and feedback? >> >> >> >> >> >> >> >> >> >> Update on the Apache Camel website and documentation >> >> >> >> >> >> The current Apache Camel website and documentation is currently >> undergoing >> >> work to be rewamped and updated for a modern website. >> >> >> >> This work has been underway for a longer time. We kicked off the work >> by >> >> migrating the documentation of every Camel component from the wiki >> system >> >> to the source code as ascii doc files. This allowed us during the build >> >> of the Apache Camel project to automatic keep parts of the >> documentation >> >> up-to-date with the source code, such as when new options is added to >> >> components. >> >> We then moved on migrate all the data formats, languages, and the EIP >> >> patterns. >> >> >> >> This has been substantional work, as if you were to print all the >> >> Camel documentation >> >> then it would be more than 3000 sheets of papers. >> >> >> >> At this point of time, we are about to draft up a new table of content >> >> (TOC) for the >> >> new Apache Camel documentation and user guide. With the new TOC we >> >> will then re-work >> >> all the user guide documentation to be updated and focus on modern >> >> developer with Camel. >> >> In doing so we will grab the good parts of the existing (older) >> >> documentation, and in >> >> places needed, we will rewrite the documentation. >> >> >> >> The new website and documentation has a new build system that is also >> >> worked. When this >> >> system is ready we will have a new staging URL where we will regularly >> >> publish the content, >> >> so users can follow the progress. >> >> >> >> Because the new documentation will be in the source code and in ascii >> >> doc format, then its >> >> easier for Camel users to contrbute and help - you can simply just >> >> submit patches as GitHub PRs. >> >> >> >> Have patience with us, as it may take a couple of months for us to be >> >> ready to publish the staging URL. >> >> >> >> We anticipate to have a new website and documentation ready after the >> >> summer break of 2018. >> >> >> >> On Tue, Mar 6, 2018 at 10:48 AM, Claus Ibsen >> >> wrote: >> >> > Hi >> >> > >> >> > I think we should post a news on the Camel front page about the >> >> > situation with the current old website and docs vs the new website >> and >> >> > docs from the source. >> >> > >> >> > A rough plan for the new website and docs could be >> >> > >> >> > - finish migrating the EIP docs >> >> > - create new TOC for new documentation >> >> > - copy over the good parts of the old docs for the new TOC and >> >> > otherwise write new parts from scratch (will be ongoing through 2018) >> >> > - build a new modern front page >> >> > - use the new Camel logo >> >> > - publish this to a new staging url so anyone can follow the work >> >> > >> >> > A work plan could be that after the 2.21 release we will finish the >> >> > EIP migrations and get started on the TOC and gradually build up the >> >> > new documentation. At the same time folks work on the new website >> with >> >> > a new build system for publishing that, and get the tech stuff in >> >> > order. >> >> > >> >> > The new front page is likely where many people may have >> feedback/ideas >> >> > and it
Re: News on front page about new website and documentation
oh, my bad. The URL that I want to share is. https://github.com/apache/incubator-servicecomb-website Willem Jiang Blog: http://willemjiang.blogspot.com (English) http://jnn.iteye.com (Chinese) Twitter: willemjiang Weibo: 姜宁willem On Thu, Apr 26, 2018 at 2:33 AM, Claus Ibsen wrote: > Hi Willem > > Great to hear you got some experience with building a website with > markdown content. > We are using ascii doc but it should be similar. > > If you wanted to refer to a link in [1] then I dont see that in your email. > > > On Wed, Apr 25, 2018 at 6:45 PM, Willem Jiang > wrote: > > +1 for bring a new website. > > > > Normally, there are some building blocks project in the github for the > > personal website. > > Last year we built a new website[1] for the ServiceComb project by using > > markdown as the content. > > Maybe we can do the same thing for the new camel website. > > > > Any thoughts? > > > > > > Willem Jiang > > > > Blog: http://willemjiang.blogspot.com (English) > > http://jnn.iteye.com (Chinese) > > Twitter: willemjiang > > Weibo: 姜宁willem > > > > On Mon, Mar 26, 2018 at 5:12 PM, Claus Ibsen > wrote: > > > >> Hi > >> > >> I have created a new draft to post on the Camel front page. > >> > >> Any comments and feedback? > >> > >> > >> > >> > >> Update on the Apache Camel website and documentation > >> > >> > >> The current Apache Camel website and documentation is currently > undergoing > >> work to be rewamped and updated for a modern website. > >> > >> This work has been underway for a longer time. We kicked off the work by > >> migrating the documentation of every Camel component from the wiki > system > >> to the source code as ascii doc files. This allowed us during the build > >> of the Apache Camel project to automatic keep parts of the documentation > >> up-to-date with the source code, such as when new options is added to > >> components. > >> We then moved on migrate all the data formats, languages, and the EIP > >> patterns. > >> > >> This has been substantional work, as if you were to print all the > >> Camel documentation > >> then it would be more than 3000 sheets of papers. > >> > >> At this point of time, we are about to draft up a new table of content > >> (TOC) for the > >> new Apache Camel documentation and user guide. With the new TOC we > >> will then re-work > >> all the user guide documentation to be updated and focus on modern > >> developer with Camel. > >> In doing so we will grab the good parts of the existing (older) > >> documentation, and in > >> places needed, we will rewrite the documentation. > >> > >> The new website and documentation has a new build system that is also > >> worked. When this > >> system is ready we will have a new staging URL where we will regularly > >> publish the content, > >> so users can follow the progress. > >> > >> Because the new documentation will be in the source code and in ascii > >> doc format, then its > >> easier for Camel users to contrbute and help - you can simply just > >> submit patches as GitHub PRs. > >> > >> Have patience with us, as it may take a couple of months for us to be > >> ready to publish the staging URL. > >> > >> We anticipate to have a new website and documentation ready after the > >> summer break of 2018. > >> > >> On Tue, Mar 6, 2018 at 10:48 AM, Claus Ibsen > >> wrote: > >> > Hi > >> > > >> > I think we should post a news on the Camel front page about the > >> > situation with the current old website and docs vs the new website and > >> > docs from the source. > >> > > >> > A rough plan for the new website and docs could be > >> > > >> > - finish migrating the EIP docs > >> > - create new TOC for new documentation > >> > - copy over the good parts of the old docs for the new TOC and > >> > otherwise write new parts from scratch (will be ongoing through 2018) > >> > - build a new modern front page > >> > - use the new Camel logo > >> > - publish this to a new staging url so anyone can follow the work > >> > > >> > A work plan could be that after the 2.21 release we will finish the > >> > EIP migrations and get started on the TOC and gradually build up the > >> > new documentation. At the same time folks work on the new website with > >> > a new build system for publishing that, and get the tech stuff in > >> > order. > >> > > >> > The new front page is likely where many people may have feedback/ideas > >> > and it can take some time to get right - if there are more proposals > >> > we could run a vote etc. Also we need new content for: > >> > - What is Apache Camel > >> > - How to get started etc > >> > > >> > eg content for onboarding new users and getting them to quickly > >> > understand what Camel is. That information is needed on both the front > >> > page and some beginner pages. > >> > > >> > As we are all busy with other duties at work / life / etc. then I dont > >> > think we can do this quickly. And therefore I anticipa
Re: News on front page about new website and documentation
+1 to move forward publishing the new website. Regards JB Le 25 avr. 2018 à 20:46, à 20:46, Willem Jiang a écrit: >+1 for bring a new website. > >Normally, there are some building blocks project in the github for the >personal website. >Last year we built a new website[1] for the ServiceComb project by >using >markdown as the content. >Maybe we can do the same thing for the new camel website. > >Any thoughts? > > >Willem Jiang > >Blog: http://willemjiang.blogspot.com (English) > http://jnn.iteye.com (Chinese) >Twitter: willemjiang >Weibo: 姜宁willem > >On Mon, Mar 26, 2018 at 5:12 PM, Claus Ibsen >wrote: > >> Hi >> >> I have created a new draft to post on the Camel front page. >> >> Any comments and feedback? >> >> >> >> >> Update on the Apache Camel website and documentation >> >> >> The current Apache Camel website and documentation is currently >undergoing >> work to be rewamped and updated for a modern website. >> >> This work has been underway for a longer time. We kicked off the work >by >> migrating the documentation of every Camel component from the wiki >system >> to the source code as ascii doc files. This allowed us during the >build >> of the Apache Camel project to automatic keep parts of the >documentation >> up-to-date with the source code, such as when new options is added to >> components. >> We then moved on migrate all the data formats, languages, and the EIP >> patterns. >> >> This has been substantional work, as if you were to print all the >> Camel documentation >> then it would be more than 3000 sheets of papers. >> >> At this point of time, we are about to draft up a new table of >content >> (TOC) for the >> new Apache Camel documentation and user guide. With the new TOC we >> will then re-work >> all the user guide documentation to be updated and focus on modern >> developer with Camel. >> In doing so we will grab the good parts of the existing (older) >> documentation, and in >> places needed, we will rewrite the documentation. >> >> The new website and documentation has a new build system that is also >> worked. When this >> system is ready we will have a new staging URL where we will >regularly >> publish the content, >> so users can follow the progress. >> >> Because the new documentation will be in the source code and in ascii >> doc format, then its >> easier for Camel users to contrbute and help - you can simply just >> submit patches as GitHub PRs. >> >> Have patience with us, as it may take a couple of months for us to be >> ready to publish the staging URL. >> >> We anticipate to have a new website and documentation ready after the >> summer break of 2018. >> >> On Tue, Mar 6, 2018 at 10:48 AM, Claus Ibsen >> wrote: >> > Hi >> > >> > I think we should post a news on the Camel front page about the >> > situation with the current old website and docs vs the new website >and >> > docs from the source. >> > >> > A rough plan for the new website and docs could be >> > >> > - finish migrating the EIP docs >> > - create new TOC for new documentation >> > - copy over the good parts of the old docs for the new TOC and >> > otherwise write new parts from scratch (will be ongoing through >2018) >> > - build a new modern front page >> > - use the new Camel logo >> > - publish this to a new staging url so anyone can follow the work >> > >> > A work plan could be that after the 2.21 release we will finish the >> > EIP migrations and get started on the TOC and gradually build up >the >> > new documentation. At the same time folks work on the new website >with >> > a new build system for publishing that, and get the tech stuff in >> > order. >> > >> > The new front page is likely where many people may have >feedback/ideas >> > and it can take some time to get right - if there are more >proposals >> > we could run a vote etc. Also we need new content for: >> > - What is Apache Camel >> > - How to get started etc >> > >> > eg content for onboarding new users and getting them to quickly >> > understand what Camel is. That information is needed on both the >front >> > page and some beginner pages. >> > >> > As we are all busy with other duties at work / life / etc. then I >dont >> > think we can do this quickly. And therefore I anticipate that we >can >> > do >> > >> > - a new stating url with a prototype of the new website and docs >ready >> > for summer 2018 >> > - continued work on the TOC and docs until its ready to replace the >old >> site >> > - switch over to new website after summer 2018 when its ready >(maybe >> > as part of Camel 2.23 release etc). >> > >> > For the news on the Camel front page, then I do think we should >draft >> > up a text that we can present. The stuff I wrote above is a bit >> > "rough" so I think we need to come up with a new text for the Camel >> > front page. >> > >> > Anyone wanna help with that? >> > >> > >> > >> > >> > >> > -- >> > Claus Ibsen >> > - >> > http://davsclaus
Re: News on front page about new website and documentation
Hi Tomo, Thank you for sharing that. I see asciidoctor (!= asciidoc) tooling as a good way to generate reference guides, not that good of a way to generate the whole static site. I think that's the reasoning why asciidoctor.org is using Awestruct. zoran On Wed, Apr 25, 2018 at 10:49 PM, Tomohisa Igarashi wrote: > Hi, > > Wasn't asciidoctor-maven-plugin an option? We're using it to generate > AtlasMap developer guide on each master build. > https://github.com/atlasmap/atlasmap/blob/dc9cceb7e7438b88e5d761b636f2f31f4d5c36ff/docs/pom.xml#L50-L71 > https://docs.atlasmap.io/ > > Thanks, > Tomo > > On Wed, 2018-04-25 at 21:55 +0200, Zoran Regvart wrote: >> Hi Cameleers, >> >> On Wed, Apr 25, 2018 at 8:33 PM, Claus Ibsen wrote: >> > We are using ascii doc but it should be similar. >> >> Just to chime in, because we use asciidoc, and just to be sure I'm not >> questioning that decision it's clearly superior choice vs markdown, >> the current stack we have on the website branch takes a really long >> time to build. Hugo static site generator has no direct support for >> asciidoc so we need to spin up a new process for each asciidoc file >> and this is quite resource intensive. >> >> An alternative was suggested in CAMEL-11499[1] to try using jbake, and >> I think I will give it a shot in the coming days... >> >> zoran >> >> [1] >> https://issues.apache.org/jira/browse/CAMEL-11499?focusedCommentId=16346954 -- Zoran Regvart
Re: News on front page about new website and documentation
Hi, Wasn't asciidoctor-maven-plugin an option? We're using it to generate AtlasMap developer guide on each master build. https://github.com/atlasmap/atlasmap/blob/dc9cceb7e7438b88e5d761b636f2f31f4d5c36ff/docs/pom.xml#L50-L71 https://docs.atlasmap.io/ Thanks, Tomo On Wed, 2018-04-25 at 21:55 +0200, Zoran Regvart wrote: > Hi Cameleers, > > On Wed, Apr 25, 2018 at 8:33 PM, Claus Ibsen wrote: > > We are using ascii doc but it should be similar. > > Just to chime in, because we use asciidoc, and just to be sure I'm not > questioning that decision it's clearly superior choice vs markdown, > the current stack we have on the website branch takes a really long > time to build. Hugo static site generator has no direct support for > asciidoc so we need to spin up a new process for each asciidoc file > and this is quite resource intensive. > > An alternative was suggested in CAMEL-11499[1] to try using jbake, and > I think I will give it a shot in the coming days... > > zoran > > [1] > https://issues.apache.org/jira/browse/CAMEL-11499?focusedCommentId=16346954
Re: News on front page about new website and documentation
Hi Cameleers, On Wed, Apr 25, 2018 at 8:33 PM, Claus Ibsen wrote: > We are using ascii doc but it should be similar. Just to chime in, because we use asciidoc, and just to be sure I'm not questioning that decision it's clearly superior choice vs markdown, the current stack we have on the website branch takes a really long time to build. Hugo static site generator has no direct support for asciidoc so we need to spin up a new process for each asciidoc file and this is quite resource intensive. An alternative was suggested in CAMEL-11499[1] to try using jbake, and I think I will give it a shot in the coming days... zoran [1] https://issues.apache.org/jira/browse/CAMEL-11499?focusedCommentId=16346954 -- Zoran Regvart
Re: News on front page about new website and documentation
Hi Willem Great to hear you got some experience with building a website with markdown content. We are using ascii doc but it should be similar. If you wanted to refer to a link in [1] then I dont see that in your email. On Wed, Apr 25, 2018 at 6:45 PM, Willem Jiang wrote: > +1 for bring a new website. > > Normally, there are some building blocks project in the github for the > personal website. > Last year we built a new website[1] for the ServiceComb project by using > markdown as the content. > Maybe we can do the same thing for the new camel website. > > Any thoughts? > > > Willem Jiang > > Blog: http://willemjiang.blogspot.com (English) > http://jnn.iteye.com (Chinese) > Twitter: willemjiang > Weibo: 姜宁willem > > On Mon, Mar 26, 2018 at 5:12 PM, Claus Ibsen wrote: > >> Hi >> >> I have created a new draft to post on the Camel front page. >> >> Any comments and feedback? >> >> >> >> >> Update on the Apache Camel website and documentation >> >> >> The current Apache Camel website and documentation is currently undergoing >> work to be rewamped and updated for a modern website. >> >> This work has been underway for a longer time. We kicked off the work by >> migrating the documentation of every Camel component from the wiki system >> to the source code as ascii doc files. This allowed us during the build >> of the Apache Camel project to automatic keep parts of the documentation >> up-to-date with the source code, such as when new options is added to >> components. >> We then moved on migrate all the data formats, languages, and the EIP >> patterns. >> >> This has been substantional work, as if you were to print all the >> Camel documentation >> then it would be more than 3000 sheets of papers. >> >> At this point of time, we are about to draft up a new table of content >> (TOC) for the >> new Apache Camel documentation and user guide. With the new TOC we >> will then re-work >> all the user guide documentation to be updated and focus on modern >> developer with Camel. >> In doing so we will grab the good parts of the existing (older) >> documentation, and in >> places needed, we will rewrite the documentation. >> >> The new website and documentation has a new build system that is also >> worked. When this >> system is ready we will have a new staging URL where we will regularly >> publish the content, >> so users can follow the progress. >> >> Because the new documentation will be in the source code and in ascii >> doc format, then its >> easier for Camel users to contrbute and help - you can simply just >> submit patches as GitHub PRs. >> >> Have patience with us, as it may take a couple of months for us to be >> ready to publish the staging URL. >> >> We anticipate to have a new website and documentation ready after the >> summer break of 2018. >> >> On Tue, Mar 6, 2018 at 10:48 AM, Claus Ibsen >> wrote: >> > Hi >> > >> > I think we should post a news on the Camel front page about the >> > situation with the current old website and docs vs the new website and >> > docs from the source. >> > >> > A rough plan for the new website and docs could be >> > >> > - finish migrating the EIP docs >> > - create new TOC for new documentation >> > - copy over the good parts of the old docs for the new TOC and >> > otherwise write new parts from scratch (will be ongoing through 2018) >> > - build a new modern front page >> > - use the new Camel logo >> > - publish this to a new staging url so anyone can follow the work >> > >> > A work plan could be that after the 2.21 release we will finish the >> > EIP migrations and get started on the TOC and gradually build up the >> > new documentation. At the same time folks work on the new website with >> > a new build system for publishing that, and get the tech stuff in >> > order. >> > >> > The new front page is likely where many people may have feedback/ideas >> > and it can take some time to get right - if there are more proposals >> > we could run a vote etc. Also we need new content for: >> > - What is Apache Camel >> > - How to get started etc >> > >> > eg content for onboarding new users and getting them to quickly >> > understand what Camel is. That information is needed on both the front >> > page and some beginner pages. >> > >> > As we are all busy with other duties at work / life / etc. then I dont >> > think we can do this quickly. And therefore I anticipate that we can >> > do >> > >> > - a new stating url with a prototype of the new website and docs ready >> > for summer 2018 >> > - continued work on the TOC and docs until its ready to replace the old >> site >> > - switch over to new website after summer 2018 when its ready (maybe >> > as part of Camel 2.23 release etc). >> > >> > For the news on the Camel front page, then I do think we should draft >> > up a text that we can present. The stuff I wrote above is a bit >> > "rough" so I think we need to come up with a new text for the Camel
Re: News on front page about new website and documentation
+1 for bring a new website. Normally, there are some building blocks project in the github for the personal website. Last year we built a new website[1] for the ServiceComb project by using markdown as the content. Maybe we can do the same thing for the new camel website. Any thoughts? Willem Jiang Blog: http://willemjiang.blogspot.com (English) http://jnn.iteye.com (Chinese) Twitter: willemjiang Weibo: 姜宁willem On Mon, Mar 26, 2018 at 5:12 PM, Claus Ibsen wrote: > Hi > > I have created a new draft to post on the Camel front page. > > Any comments and feedback? > > > > > Update on the Apache Camel website and documentation > > > The current Apache Camel website and documentation is currently undergoing > work to be rewamped and updated for a modern website. > > This work has been underway for a longer time. We kicked off the work by > migrating the documentation of every Camel component from the wiki system > to the source code as ascii doc files. This allowed us during the build > of the Apache Camel project to automatic keep parts of the documentation > up-to-date with the source code, such as when new options is added to > components. > We then moved on migrate all the data formats, languages, and the EIP > patterns. > > This has been substantional work, as if you were to print all the > Camel documentation > then it would be more than 3000 sheets of papers. > > At this point of time, we are about to draft up a new table of content > (TOC) for the > new Apache Camel documentation and user guide. With the new TOC we > will then re-work > all the user guide documentation to be updated and focus on modern > developer with Camel. > In doing so we will grab the good parts of the existing (older) > documentation, and in > places needed, we will rewrite the documentation. > > The new website and documentation has a new build system that is also > worked. When this > system is ready we will have a new staging URL where we will regularly > publish the content, > so users can follow the progress. > > Because the new documentation will be in the source code and in ascii > doc format, then its > easier for Camel users to contrbute and help - you can simply just > submit patches as GitHub PRs. > > Have patience with us, as it may take a couple of months for us to be > ready to publish the staging URL. > > We anticipate to have a new website and documentation ready after the > summer break of 2018. > > On Tue, Mar 6, 2018 at 10:48 AM, Claus Ibsen > wrote: > > Hi > > > > I think we should post a news on the Camel front page about the > > situation with the current old website and docs vs the new website and > > docs from the source. > > > > A rough plan for the new website and docs could be > > > > - finish migrating the EIP docs > > - create new TOC for new documentation > > - copy over the good parts of the old docs for the new TOC and > > otherwise write new parts from scratch (will be ongoing through 2018) > > - build a new modern front page > > - use the new Camel logo > > - publish this to a new staging url so anyone can follow the work > > > > A work plan could be that after the 2.21 release we will finish the > > EIP migrations and get started on the TOC and gradually build up the > > new documentation. At the same time folks work on the new website with > > a new build system for publishing that, and get the tech stuff in > > order. > > > > The new front page is likely where many people may have feedback/ideas > > and it can take some time to get right - if there are more proposals > > we could run a vote etc. Also we need new content for: > > - What is Apache Camel > > - How to get started etc > > > > eg content for onboarding new users and getting them to quickly > > understand what Camel is. That information is needed on both the front > > page and some beginner pages. > > > > As we are all busy with other duties at work / life / etc. then I dont > > think we can do this quickly. And therefore I anticipate that we can > > do > > > > - a new stating url with a prototype of the new website and docs ready > > for summer 2018 > > - continued work on the TOC and docs until its ready to replace the old > site > > - switch over to new website after summer 2018 when its ready (maybe > > as part of Camel 2.23 release etc). > > > > For the news on the Camel front page, then I do think we should draft > > up a text that we can present. The stuff I wrote above is a bit > > "rough" so I think we need to come up with a new text for the Camel > > front page. > > > > Anyone wanna help with that? > > > > > > > > > > > > -- > > Claus Ibsen > > - > > http://davsclaus.com @davsclaus > > Camel in Action 2: https://www.manning.com/ibsen2 > > > > -- > Claus Ibsen > - > http://davsclaus.com @davsclaus > Camel in Action 2: https://www.manning.com/ibsen2 >
Re: News on front page about new website and documentation
Hi I am posting this on the front page. On Wed, Mar 28, 2018 at 6:22 PM, Claus Ibsen wrote: > On Wed, Mar 28, 2018 at 9:11 AM, Gregor Zurowski > wrote: >> Hi, >> >> I can post it to the front page right after posting updates about our >> upcoming releases. Should be done by tomorrow. >> > > Yeah sure this is fine. > > >> Thanks, >> Gregor >> >> >> On Wed, Mar 28, 2018, 8:28 AM Claus Ibsen wrote: >> >>> Hi >>> >>> I think we should wait to post this on the front page, until after the >>> 2.19.5 and 2.20.3 releases, so it will be on top of those and stay on >>> top for a longer while. >>> >>> On Mon, Mar 26, 2018 at 11:12 AM, Claus Ibsen >>> wrote: >>> > Hi >>> > >>> > I have created a new draft to post on the Camel front page. >>> > >>> > Any comments and feedback? >>> > >>> > >>> > >>> > >>> > Update on the Apache Camel website and documentation >>> > >>> > >>> > The current Apache Camel website and documentation is currently >>> undergoing >>> > work to be rewamped and updated for a modern website. >>> > >>> > This work has been underway for a longer time. We kicked off the work by >>> > migrating the documentation of every Camel component from the wiki system >>> > to the source code as ascii doc files. This allowed us during the build >>> > of the Apache Camel project to automatic keep parts of the documentation >>> > up-to-date with the source code, such as when new options is added to >>> > components. >>> > We then moved on migrate all the data formats, languages, and the EIP >>> patterns. >>> > >>> > This has been substantional work, as if you were to print all the >>> > Camel documentation >>> > then it would be more than 3000 sheets of papers. >>> > >>> > At this point of time, we are about to draft up a new table of content >>> > (TOC) for the >>> > new Apache Camel documentation and user guide. With the new TOC we >>> > will then re-work >>> > all the user guide documentation to be updated and focus on modern >>> > developer with Camel. >>> > In doing so we will grab the good parts of the existing (older) >>> > documentation, and in >>> > places needed, we will rewrite the documentation. >>> > >>> > The new website and documentation has a new build system that is also >>> > worked. When this >>> > system is ready we will have a new staging URL where we will regularly >>> > publish the content, >>> > so users can follow the progress. >>> > >>> > Because the new documentation will be in the source code and in ascii >>> > doc format, then its >>> > easier for Camel users to contrbute and help - you can simply just >>> > submit patches as GitHub PRs. >>> > >>> > Have patience with us, as it may take a couple of months for us to be >>> > ready to publish the staging URL. >>> > >>> > We anticipate to have a new website and documentation ready after the >>> > summer break of 2018. >>> > >>> > On Tue, Mar 6, 2018 at 10:48 AM, Claus Ibsen >>> wrote: >>> >> Hi >>> >> >>> >> I think we should post a news on the Camel front page about the >>> >> situation with the current old website and docs vs the new website and >>> >> docs from the source. >>> >> >>> >> A rough plan for the new website and docs could be >>> >> >>> >> - finish migrating the EIP docs >>> >> - create new TOC for new documentation >>> >> - copy over the good parts of the old docs for the new TOC and >>> >> otherwise write new parts from scratch (will be ongoing through 2018) >>> >> - build a new modern front page >>> >> - use the new Camel logo >>> >> - publish this to a new staging url so anyone can follow the work >>> >> >>> >> A work plan could be that after the 2.21 release we will finish the >>> >> EIP migrations and get started on the TOC and gradually build up the >>> >> new documentation. At the same time folks work on the new website with >>> >> a new build system for publishing that, and get the tech stuff in >>> >> order. >>> >> >>> >> The new front page is likely where many people may have feedback/ideas >>> >> and it can take some time to get right - if there are more proposals >>> >> we could run a vote etc. Also we need new content for: >>> >> - What is Apache Camel >>> >> - How to get started etc >>> >> >>> >> eg content for onboarding new users and getting them to quickly >>> >> understand what Camel is. That information is needed on both the front >>> >> page and some beginner pages. >>> >> >>> >> As we are all busy with other duties at work / life / etc. then I dont >>> >> think we can do this quickly. And therefore I anticipate that we can >>> >> do >>> >> >>> >> - a new stating url with a prototype of the new website and docs ready >>> >> for summer 2018 >>> >> - continued work on the TOC and docs until its ready to replace the old >>> site >>> >> - switch over to new website after summer 2018 when its ready (maybe >>> >> as part of Camel 2.23 release etc). >>> >> >>> >> For the news on the Camel front page, then I do think we should draft >>> >> up a text that
Re: News on front page about new website and documentation
On Wed, Mar 28, 2018 at 9:11 AM, Gregor Zurowski wrote: > Hi, > > I can post it to the front page right after posting updates about our > upcoming releases. Should be done by tomorrow. > Yeah sure this is fine. > Thanks, > Gregor > > > On Wed, Mar 28, 2018, 8:28 AM Claus Ibsen wrote: > >> Hi >> >> I think we should wait to post this on the front page, until after the >> 2.19.5 and 2.20.3 releases, so it will be on top of those and stay on >> top for a longer while. >> >> On Mon, Mar 26, 2018 at 11:12 AM, Claus Ibsen >> wrote: >> > Hi >> > >> > I have created a new draft to post on the Camel front page. >> > >> > Any comments and feedback? >> > >> > >> > >> > >> > Update on the Apache Camel website and documentation >> > >> > >> > The current Apache Camel website and documentation is currently >> undergoing >> > work to be rewamped and updated for a modern website. >> > >> > This work has been underway for a longer time. We kicked off the work by >> > migrating the documentation of every Camel component from the wiki system >> > to the source code as ascii doc files. This allowed us during the build >> > of the Apache Camel project to automatic keep parts of the documentation >> > up-to-date with the source code, such as when new options is added to >> > components. >> > We then moved on migrate all the data formats, languages, and the EIP >> patterns. >> > >> > This has been substantional work, as if you were to print all the >> > Camel documentation >> > then it would be more than 3000 sheets of papers. >> > >> > At this point of time, we are about to draft up a new table of content >> > (TOC) for the >> > new Apache Camel documentation and user guide. With the new TOC we >> > will then re-work >> > all the user guide documentation to be updated and focus on modern >> > developer with Camel. >> > In doing so we will grab the good parts of the existing (older) >> > documentation, and in >> > places needed, we will rewrite the documentation. >> > >> > The new website and documentation has a new build system that is also >> > worked. When this >> > system is ready we will have a new staging URL where we will regularly >> > publish the content, >> > so users can follow the progress. >> > >> > Because the new documentation will be in the source code and in ascii >> > doc format, then its >> > easier for Camel users to contrbute and help - you can simply just >> > submit patches as GitHub PRs. >> > >> > Have patience with us, as it may take a couple of months for us to be >> > ready to publish the staging URL. >> > >> > We anticipate to have a new website and documentation ready after the >> > summer break of 2018. >> > >> > On Tue, Mar 6, 2018 at 10:48 AM, Claus Ibsen >> wrote: >> >> Hi >> >> >> >> I think we should post a news on the Camel front page about the >> >> situation with the current old website and docs vs the new website and >> >> docs from the source. >> >> >> >> A rough plan for the new website and docs could be >> >> >> >> - finish migrating the EIP docs >> >> - create new TOC for new documentation >> >> - copy over the good parts of the old docs for the new TOC and >> >> otherwise write new parts from scratch (will be ongoing through 2018) >> >> - build a new modern front page >> >> - use the new Camel logo >> >> - publish this to a new staging url so anyone can follow the work >> >> >> >> A work plan could be that after the 2.21 release we will finish the >> >> EIP migrations and get started on the TOC and gradually build up the >> >> new documentation. At the same time folks work on the new website with >> >> a new build system for publishing that, and get the tech stuff in >> >> order. >> >> >> >> The new front page is likely where many people may have feedback/ideas >> >> and it can take some time to get right - if there are more proposals >> >> we could run a vote etc. Also we need new content for: >> >> - What is Apache Camel >> >> - How to get started etc >> >> >> >> eg content for onboarding new users and getting them to quickly >> >> understand what Camel is. That information is needed on both the front >> >> page and some beginner pages. >> >> >> >> As we are all busy with other duties at work / life / etc. then I dont >> >> think we can do this quickly. And therefore I anticipate that we can >> >> do >> >> >> >> - a new stating url with a prototype of the new website and docs ready >> >> for summer 2018 >> >> - continued work on the TOC and docs until its ready to replace the old >> site >> >> - switch over to new website after summer 2018 when its ready (maybe >> >> as part of Camel 2.23 release etc). >> >> >> >> For the news on the Camel front page, then I do think we should draft >> >> up a text that we can present. The stuff I wrote above is a bit >> >> "rough" so I think we need to come up with a new text for the Camel >> >> front page. >> >> >> >> Anyone wanna help with that? >> >> >> >> >> >> >> >> >> >> >> >> -- >> >
Re: News on front page about new website and documentation
Hi, I can post it to the front page right after posting updates about our upcoming releases. Should be done by tomorrow. Thanks, Gregor On Wed, Mar 28, 2018, 8:28 AM Claus Ibsen wrote: > Hi > > I think we should wait to post this on the front page, until after the > 2.19.5 and 2.20.3 releases, so it will be on top of those and stay on > top for a longer while. > > On Mon, Mar 26, 2018 at 11:12 AM, Claus Ibsen > wrote: > > Hi > > > > I have created a new draft to post on the Camel front page. > > > > Any comments and feedback? > > > > > > > > > > Update on the Apache Camel website and documentation > > > > > > The current Apache Camel website and documentation is currently > undergoing > > work to be rewamped and updated for a modern website. > > > > This work has been underway for a longer time. We kicked off the work by > > migrating the documentation of every Camel component from the wiki system > > to the source code as ascii doc files. This allowed us during the build > > of the Apache Camel project to automatic keep parts of the documentation > > up-to-date with the source code, such as when new options is added to > > components. > > We then moved on migrate all the data formats, languages, and the EIP > patterns. > > > > This has been substantional work, as if you were to print all the > > Camel documentation > > then it would be more than 3000 sheets of papers. > > > > At this point of time, we are about to draft up a new table of content > > (TOC) for the > > new Apache Camel documentation and user guide. With the new TOC we > > will then re-work > > all the user guide documentation to be updated and focus on modern > > developer with Camel. > > In doing so we will grab the good parts of the existing (older) > > documentation, and in > > places needed, we will rewrite the documentation. > > > > The new website and documentation has a new build system that is also > > worked. When this > > system is ready we will have a new staging URL where we will regularly > > publish the content, > > so users can follow the progress. > > > > Because the new documentation will be in the source code and in ascii > > doc format, then its > > easier for Camel users to contrbute and help - you can simply just > > submit patches as GitHub PRs. > > > > Have patience with us, as it may take a couple of months for us to be > > ready to publish the staging URL. > > > > We anticipate to have a new website and documentation ready after the > > summer break of 2018. > > > > On Tue, Mar 6, 2018 at 10:48 AM, Claus Ibsen > wrote: > >> Hi > >> > >> I think we should post a news on the Camel front page about the > >> situation with the current old website and docs vs the new website and > >> docs from the source. > >> > >> A rough plan for the new website and docs could be > >> > >> - finish migrating the EIP docs > >> - create new TOC for new documentation > >> - copy over the good parts of the old docs for the new TOC and > >> otherwise write new parts from scratch (will be ongoing through 2018) > >> - build a new modern front page > >> - use the new Camel logo > >> - publish this to a new staging url so anyone can follow the work > >> > >> A work plan could be that after the 2.21 release we will finish the > >> EIP migrations and get started on the TOC and gradually build up the > >> new documentation. At the same time folks work on the new website with > >> a new build system for publishing that, and get the tech stuff in > >> order. > >> > >> The new front page is likely where many people may have feedback/ideas > >> and it can take some time to get right - if there are more proposals > >> we could run a vote etc. Also we need new content for: > >> - What is Apache Camel > >> - How to get started etc > >> > >> eg content for onboarding new users and getting them to quickly > >> understand what Camel is. That information is needed on both the front > >> page and some beginner pages. > >> > >> As we are all busy with other duties at work / life / etc. then I dont > >> think we can do this quickly. And therefore I anticipate that we can > >> do > >> > >> - a new stating url with a prototype of the new website and docs ready > >> for summer 2018 > >> - continued work on the TOC and docs until its ready to replace the old > site > >> - switch over to new website after summer 2018 when its ready (maybe > >> as part of Camel 2.23 release etc). > >> > >> For the news on the Camel front page, then I do think we should draft > >> up a text that we can present. The stuff I wrote above is a bit > >> "rough" so I think we need to come up with a new text for the Camel > >> front page. > >> > >> Anyone wanna help with that? > >> > >> > >> > >> > >> > >> -- > >> Claus Ibsen > >> - > >> http://davsclaus.com @davsclaus > >> Camel in Action 2: https://www.manning.com/ibsen2 > > > > > > > > -- > > Claus Ibsen > > - > > http://davsclaus.com @davsclaus >
Re: News on front page about new website and documentation
Hi I think we should wait to post this on the front page, until after the 2.19.5 and 2.20.3 releases, so it will be on top of those and stay on top for a longer while. On Mon, Mar 26, 2018 at 11:12 AM, Claus Ibsen wrote: > Hi > > I have created a new draft to post on the Camel front page. > > Any comments and feedback? > > > > > Update on the Apache Camel website and documentation > > > The current Apache Camel website and documentation is currently undergoing > work to be rewamped and updated for a modern website. > > This work has been underway for a longer time. We kicked off the work by > migrating the documentation of every Camel component from the wiki system > to the source code as ascii doc files. This allowed us during the build > of the Apache Camel project to automatic keep parts of the documentation > up-to-date with the source code, such as when new options is added to > components. > We then moved on migrate all the data formats, languages, and the EIP > patterns. > > This has been substantional work, as if you were to print all the > Camel documentation > then it would be more than 3000 sheets of papers. > > At this point of time, we are about to draft up a new table of content > (TOC) for the > new Apache Camel documentation and user guide. With the new TOC we > will then re-work > all the user guide documentation to be updated and focus on modern > developer with Camel. > In doing so we will grab the good parts of the existing (older) > documentation, and in > places needed, we will rewrite the documentation. > > The new website and documentation has a new build system that is also > worked. When this > system is ready we will have a new staging URL where we will regularly > publish the content, > so users can follow the progress. > > Because the new documentation will be in the source code and in ascii > doc format, then its > easier for Camel users to contrbute and help - you can simply just > submit patches as GitHub PRs. > > Have patience with us, as it may take a couple of months for us to be > ready to publish the staging URL. > > We anticipate to have a new website and documentation ready after the > summer break of 2018. > > On Tue, Mar 6, 2018 at 10:48 AM, Claus Ibsen wrote: >> Hi >> >> I think we should post a news on the Camel front page about the >> situation with the current old website and docs vs the new website and >> docs from the source. >> >> A rough plan for the new website and docs could be >> >> - finish migrating the EIP docs >> - create new TOC for new documentation >> - copy over the good parts of the old docs for the new TOC and >> otherwise write new parts from scratch (will be ongoing through 2018) >> - build a new modern front page >> - use the new Camel logo >> - publish this to a new staging url so anyone can follow the work >> >> A work plan could be that after the 2.21 release we will finish the >> EIP migrations and get started on the TOC and gradually build up the >> new documentation. At the same time folks work on the new website with >> a new build system for publishing that, and get the tech stuff in >> order. >> >> The new front page is likely where many people may have feedback/ideas >> and it can take some time to get right - if there are more proposals >> we could run a vote etc. Also we need new content for: >> - What is Apache Camel >> - How to get started etc >> >> eg content for onboarding new users and getting them to quickly >> understand what Camel is. That information is needed on both the front >> page and some beginner pages. >> >> As we are all busy with other duties at work / life / etc. then I dont >> think we can do this quickly. And therefore I anticipate that we can >> do >> >> - a new stating url with a prototype of the new website and docs ready >> for summer 2018 >> - continued work on the TOC and docs until its ready to replace the old site >> - switch over to new website after summer 2018 when its ready (maybe >> as part of Camel 2.23 release etc). >> >> For the news on the Camel front page, then I do think we should draft >> up a text that we can present. The stuff I wrote above is a bit >> "rough" so I think we need to come up with a new text for the Camel >> front page. >> >> Anyone wanna help with that? >> >> >> >> >> >> -- >> Claus Ibsen >> - >> http://davsclaus.com @davsclaus >> Camel in Action 2: https://www.manning.com/ibsen2 > > > > -- > Claus Ibsen > - > http://davsclaus.com @davsclaus > Camel in Action 2: https://www.manning.com/ibsen2 -- Claus Ibsen - http://davsclaus.com @davsclaus Camel in Action 2: https://www.manning.com/ibsen2
Re: News on front page about new website and documentation
+1. Thanks a lot. -- Andrea Cosentino -- Apache Camel PMC Member Apache Karaf Committer Apache Servicemix PMC Member Email: ancosen1...@yahoo.com Twitter: @oscerd2 Github: oscerd On Monday, March 26, 2018, 11:13:09 AM GMT+2, Claus Ibsen wrote: Hi I have created a new draft to post on the Camel front page. Any comments and feedback? Update on the Apache Camel website and documentation The current Apache Camel website and documentation is currently undergoing work to be rewamped and updated for a modern website. This work has been underway for a longer time. We kicked off the work by migrating the documentation of every Camel component from the wiki system to the source code as ascii doc files. This allowed us during the build of the Apache Camel project to automatic keep parts of the documentation up-to-date with the source code, such as when new options is added to components. We then moved on migrate all the data formats, languages, and the EIP patterns. This has been substantional work, as if you were to print all the Camel documentation then it would be more than 3000 sheets of papers. At this point of time, we are about to draft up a new table of content (TOC) for the new Apache Camel documentation and user guide. With the new TOC we will then re-work all the user guide documentation to be updated and focus on modern developer with Camel. In doing so we will grab the good parts of the existing (older) documentation, and in places needed, we will rewrite the documentation. The new website and documentation has a new build system that is also worked. When this system is ready we will have a new staging URL where we will regularly publish the content, so users can follow the progress. Because the new documentation will be in the source code and in ascii doc format, then its easier for Camel users to contrbute and help - you can simply just submit patches as GitHub PRs. Have patience with us, as it may take a couple of months for us to be ready to publish the staging URL. We anticipate to have a new website and documentation ready after the summer break of 2018. On Tue, Mar 6, 2018 at 10:48 AM, Claus Ibsen wrote: > Hi > > I think we should post a news on the Camel front page about the > situation with the current old website and docs vs the new website and > docs from the source. > > A rough plan for the new website and docs could be > > - finish migrating the EIP docs > - create new TOC for new documentation > - copy over the good parts of the old docs for the new TOC and > otherwise write new parts from scratch (will be ongoing through 2018) > - build a new modern front page > - use the new Camel logo > - publish this to a new staging url so anyone can follow the work > > A work plan could be that after the 2.21 release we will finish the > EIP migrations and get started on the TOC and gradually build up the > new documentation. At the same time folks work on the new website with > a new build system for publishing that, and get the tech stuff in > order. > > The new front page is likely where many people may have feedback/ideas > and it can take some time to get right - if there are more proposals > we could run a vote etc. Also we need new content for: > - What is Apache Camel > - How to get started etc > > eg content for onboarding new users and getting them to quickly > understand what Camel is. That information is needed on both the front > page and some beginner pages. > > As we are all busy with other duties at work / life / etc. then I dont > think we can do this quickly. And therefore I anticipate that we can > do > > - a new stating url with a prototype of the new website and docs ready > for summer 2018 > - continued work on the TOC and docs until its ready to replace the old site > - switch over to new website after summer 2018 when its ready (maybe > as part of Camel 2.23 release etc). > > For the news on the Camel front page, then I do think we should draft > up a text that we can present. The stuff I wrote above is a bit > "rough" so I think we need to come up with a new text for the Camel > front page. > > Anyone wanna help with that? > > > > > > -- > Claus Ibsen > - > http://davsclaus.com @davsclaus > Camel in Action 2: https://www.manning.com/ibsen2 -- Claus Ibsen - http://davsclaus.com @davsclaus Camel in Action 2: https://www.manning.com/ibsen2
Re: News on front page about new website and documentation
Hi I have created a new draft to post on the Camel front page. Any comments and feedback? Update on the Apache Camel website and documentation The current Apache Camel website and documentation is currently undergoing work to be rewamped and updated for a modern website. This work has been underway for a longer time. We kicked off the work by migrating the documentation of every Camel component from the wiki system to the source code as ascii doc files. This allowed us during the build of the Apache Camel project to automatic keep parts of the documentation up-to-date with the source code, such as when new options is added to components. We then moved on migrate all the data formats, languages, and the EIP patterns. This has been substantional work, as if you were to print all the Camel documentation then it would be more than 3000 sheets of papers. At this point of time, we are about to draft up a new table of content (TOC) for the new Apache Camel documentation and user guide. With the new TOC we will then re-work all the user guide documentation to be updated and focus on modern developer with Camel. In doing so we will grab the good parts of the existing (older) documentation, and in places needed, we will rewrite the documentation. The new website and documentation has a new build system that is also worked. When this system is ready we will have a new staging URL where we will regularly publish the content, so users can follow the progress. Because the new documentation will be in the source code and in ascii doc format, then its easier for Camel users to contrbute and help - you can simply just submit patches as GitHub PRs. Have patience with us, as it may take a couple of months for us to be ready to publish the staging URL. We anticipate to have a new website and documentation ready after the summer break of 2018. On Tue, Mar 6, 2018 at 10:48 AM, Claus Ibsen wrote: > Hi > > I think we should post a news on the Camel front page about the > situation with the current old website and docs vs the new website and > docs from the source. > > A rough plan for the new website and docs could be > > - finish migrating the EIP docs > - create new TOC for new documentation > - copy over the good parts of the old docs for the new TOC and > otherwise write new parts from scratch (will be ongoing through 2018) > - build a new modern front page > - use the new Camel logo > - publish this to a new staging url so anyone can follow the work > > A work plan could be that after the 2.21 release we will finish the > EIP migrations and get started on the TOC and gradually build up the > new documentation. At the same time folks work on the new website with > a new build system for publishing that, and get the tech stuff in > order. > > The new front page is likely where many people may have feedback/ideas > and it can take some time to get right - if there are more proposals > we could run a vote etc. Also we need new content for: > - What is Apache Camel > - How to get started etc > > eg content for onboarding new users and getting them to quickly > understand what Camel is. That information is needed on both the front > page and some beginner pages. > > As we are all busy with other duties at work / life / etc. then I dont > think we can do this quickly. And therefore I anticipate that we can > do > > - a new stating url with a prototype of the new website and docs ready > for summer 2018 > - continued work on the TOC and docs until its ready to replace the old site > - switch over to new website after summer 2018 when its ready (maybe > as part of Camel 2.23 release etc). > > For the news on the Camel front page, then I do think we should draft > up a text that we can present. The stuff I wrote above is a bit > "rough" so I think we need to come up with a new text for the Camel > front page. > > Anyone wanna help with that? > > > > > > -- > Claus Ibsen > - > http://davsclaus.com @davsclaus > Camel in Action 2: https://www.manning.com/ibsen2 -- Claus Ibsen - http://davsclaus.com @davsclaus Camel in Action 2: https://www.manning.com/ibsen2
Re: Re: News on front page about new website and documentation
On Fri, Mar 9, 2018 at 1:47 AM, Sascha Dirbach wrote: > Hi > > Am 06.03.2018 um 10:48 schrieb Claus Ibsen: >> >> Anyone wanna help with that? > > > I would also be interested on helping. > > Is there already a channel to coordinate that work? > We will talk on this @dev mailing list on ASF, then anybody can see, participate and help. > Kind regards, > Sascha > -- Claus Ibsen - http://davsclaus.com @davsclaus Camel in Action 2: https://www.manning.com/ibsen2
Re: News on front page about new website and documentation
Hi, I also want to help with it. best Bennet > On 9. Mar 2018, at 1:47 AM, Sascha Dirbach > wrote: > > Hi > > Am 06.03.2018 um 10:48 schrieb Claus Ibsen: >> Anyone wanna help with that? > > I would also be interested on helping. > > Is there already a channel to coordinate that work? > > Kind regards, > Sascha >
Fwd: Re: News on front page about new website and documentation
Hi Am 06.03.2018 um 10:48 schrieb Claus Ibsen: Anyone wanna help with that? I would also be interested on helping. Is there already a channel to coordinate that work? Kind regards, Sascha
Re: News on front page about new website and documentation
Hello Cameleers, On Tue, Mar 6, 2018 at 10:48 AM, Claus Ibsen wrote: > Anyone wanna help with that? This is certainly something I'm very passionate about, I hope that I can find more time in the coming weeks to help with this. zoran -- Zoran Regvart
Re: News on front page about new website and documentation
I think this is a great idea. I for one, can say that I didn’t even know the GitHub docs existed until Oscerd pointed me to them. I’d certainly help contribute with the website; however, I am unsure as to what would be the best plan of action. In my opinion, I see us hosting a clean, website with general details which points to our Github for anything in the “nitty gritty”, technical side of Camel. Should we start a new channel for this on Gitter? Best, Chad On 3/7/18, 5:06 AM, "Onder SEZGIN" wrote: I am in. Not sure about timeline, though. On Tue, 6 Mar 2018 at 12:49, Claus Ibsen wrote: > Hi > > I think we should post a news on the Camel front page about the > situation with the current old website and docs vs the new website and > docs from the source. > > A rough plan for the new website and docs could be > > - finish migrating the EIP docs > - create new TOC for new documentation > - copy over the good parts of the old docs for the new TOC and > otherwise write new parts from scratch (will be ongoing through 2018) > - build a new modern front page > - use the new Camel logo > - publish this to a new staging url so anyone can follow the work > > A work plan could be that after the 2.21 release we will finish the > EIP migrations and get started on the TOC and gradually build up the > new documentation. At the same time folks work on the new website with > a new build system for publishing that, and get the tech stuff in > order. > > The new front page is likely where many people may have feedback/ideas > and it can take some time to get right - if there are more proposals > we could run a vote etc. Also we need new content for: > - What is Apache Camel > - How to get started etc > > eg content for onboarding new users and getting them to quickly > understand what Camel is. That information is needed on both the front > page and some beginner pages. > > As we are all busy with other duties at work / life / etc. then I dont > think we can do this quickly. And therefore I anticipate that we can > do > > - a new stating url with a prototype of the new website and docs ready > for summer 2018 > - continued work on the TOC and docs until its ready to replace the old > site > - switch over to new website after summer 2018 when its ready (maybe > as part of Camel 2.23 release etc). > > For the news on the Camel front page, then I do think we should draft > up a text that we can present. The stuff I wrote above is a bit > "rough" so I think we need to come up with a new text for the Camel > front page. > > Anyone wanna help with that? > > > > > > -- > Claus Ibsen > - > http://davsclaus.com @davsclaus > Camel in Action 2: https://www.manning.com/ibsen2 >
Re: News on front page about new website and documentation
I am in. Not sure about timeline, though. On Tue, 6 Mar 2018 at 12:49, Claus Ibsen wrote: > Hi > > I think we should post a news on the Camel front page about the > situation with the current old website and docs vs the new website and > docs from the source. > > A rough plan for the new website and docs could be > > - finish migrating the EIP docs > - create new TOC for new documentation > - copy over the good parts of the old docs for the new TOC and > otherwise write new parts from scratch (will be ongoing through 2018) > - build a new modern front page > - use the new Camel logo > - publish this to a new staging url so anyone can follow the work > > A work plan could be that after the 2.21 release we will finish the > EIP migrations and get started on the TOC and gradually build up the > new documentation. At the same time folks work on the new website with > a new build system for publishing that, and get the tech stuff in > order. > > The new front page is likely where many people may have feedback/ideas > and it can take some time to get right - if there are more proposals > we could run a vote etc. Also we need new content for: > - What is Apache Camel > - How to get started etc > > eg content for onboarding new users and getting them to quickly > understand what Camel is. That information is needed on both the front > page and some beginner pages. > > As we are all busy with other duties at work / life / etc. then I dont > think we can do this quickly. And therefore I anticipate that we can > do > > - a new stating url with a prototype of the new website and docs ready > for summer 2018 > - continued work on the TOC and docs until its ready to replace the old > site > - switch over to new website after summer 2018 when its ready (maybe > as part of Camel 2.23 release etc). > > For the news on the Camel front page, then I do think we should draft > up a text that we can present. The stuff I wrote above is a bit > "rough" so I think we need to come up with a new text for the Camel > front page. > > Anyone wanna help with that? > > > > > > -- > Claus Ibsen > - > http://davsclaus.com @davsclaus > Camel in Action 2: https://www.manning.com/ibsen2 >
