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 <willem.ji...@gmail.com> 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 <zo...@regvart.com> 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 <willem.ji...@gmail.com> >> 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 <willem.ji...@gmail.com> >> > 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 <claus.ib...@gmail.com> >> >> 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 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 <claus.ib...@gmail.com >> > >> >>> >> 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 >> >>> >> >> >> >> >> >> >> >> -- >> Zoran Regvart >> -- Claus Ibsen ----------------- http://davsclaus.com @davsclaus Camel in Action 2: https://www.manning.com/ibsen2
