Hi Önder, thanks for the feedback! On Thu, Dec 13, 2018 at 7:56 AM Onder SEZGIN <ond...@apache.org> wrote: > There is one point i am not %100 sure as we always say that documents will > be auto-generated from source code in asciidoc format and we also have > variosu other pages edited manually (especially examples for components). > After all these, are we going to keep all manually edited pages in > somewhere or we aim to drop them of from the offical documentation and have > them in somewhere else.
That's also one of the reasons I think Antora is a good choice. The only way to build documentation is to version it in source control. So for examples we can have an additional Antora module just with the examples. This can then be versioned (or not). I don't see an issue with having more documentation, manually or auto-generated, I think we should embrace automation (as we have) on the parts that can be extracted from the source. This is somewhat reflected in the why I envisioned the current documentation being incorporated: user manual is always built from `master`, and for component documentation we can have one from `master` and multiple for older (maintained) releases. I hope this clarifies my position a bit, if it doesn't please let's keep this conversation going. > And one note i have in terms of documentation, (there are of course quite a > lot of books) is that having doc pages around where different integration > flavours using even small pieces of camel would be very helpful. (of course > there is also blog posts, tutorials and etc... ). surely having such pages > and maintaining them will bring lots of doc management issues and maybe > JIRAs to follow up but in the longer run it will be a great doc base to > start using camel for devs at any level. and maybe maintaing those doc > bases with diffferent versions of camel and upgrading and fixing them is > also a bit of hassle but it will keep track of changes in different > integration styles and env. (CDI, Blueprint, Spring Boot, Karaf, > Standalone, Camel-K), etcc... Just an idea which may get deeper ?? That's a good point, keeping the documentation up to date is a big task we all have to take on. I'm hoping that having it in versioned in git and with a 'Edit' link on the website that takes you to GitHub will help drive contributions to the documentation via pull requests. We should really take care on the new website that this way of contribution is really smooth and easy. zoran -- Zoran Regvart
