Re: Feature Model How-To Series Proposal

2020-06-17 Thread Carsten Ziegeler
Thanks Gaston, I think the PR is good to go, waiting for others to chime in A PR for the feature model README with links back to the How-Tos landing page sounds great! Afaik, we don't have concrete plans for downloads of feature models or archives, but thats certainly something we could do.

Re: Feature Model How-To Series Proposal

2020-06-17 Thread Gaston Gonzalez
Hi All, I updated the PR with your feedback. If there is anything else that requires changes, please let me know. A couple of questions on my end: Would you like me to create a PR that links the Feature Model README back to the main How-To landing page? Are there plans to create an official Sli

Re: Feature Model How-To Series Proposal

2020-06-17 Thread Carsten Ziegeler
It is in no way duplicate but additional - if someone wants to move that content to the plugin site documentation, that's fine. Still, the site deployment requires extra steps and they get easily forgotten as we can see on our web site. For example for the feature model plugin, latest publishe

Re: Feature Model How-To Series Proposal

2020-06-17 Thread Carsten Ziegeler
Getting back to the real topic :) I think the howtos could be part of the site - most of them are about more than one module. As commented on the PR, maybe the introduction can be shortened to reduce duplication with what is already in the feature model git repository. But that's more a sugg

Re: Feature Model How-To Series Proposal

2020-06-17 Thread Konrad Windszus
Maintaining all mojos with parameters correctly manually in the README is a lot of overhead (IMHO more than generating the site). This information comes for free from the code! Strongly recommend to remove that duplicate info from the readme and instead start generating the site :-) The steps ar

Re: Feature Model How-To Series Proposal

2020-06-17 Thread Carsten Ziegeler
Releasing the site requires extra steps which easily gets forgotten. Right now, the majority of the documentation is in the README in git and the site points to that file Carsten Am 17.06.2020 um 15:38 schrieb Konrad Windszus: For the maven-plugins let us rely on the generated site (which ev

Re: Feature Model How-To Series Proposal

2020-06-17 Thread Konrad Windszus
For the maven-plugins let us rely on the generated site (which evaluates javadoc and other metainformation already nicely) and allows to use MD for additional pages. I prefer that for maven-plugins over a big readme as generating the site is a no-brainer during the release and has a standard fo

Re: Feature Model How-To Series Proposal

2020-06-17 Thread Carsten Ziegeler
Thanks Bertrand, that definitely works for me - and is inline with my thoughts as well :) Regards Carsten Am 17.06.2020 um 11:00 schrieb Bertrand Delacretaz: Hi, On Wed, Jun 17, 2020 at 7:50 AM Carsten Ziegeler wrote: ...Now, I don't want to open a big box here and I don't want to block suc

Re: Feature Model How-To Series Proposal

2020-06-17 Thread Bertrand Delacretaz
Hi, On Wed, Jun 17, 2020 at 7:50 AM Carsten Ziegeler wrote: > ...Now, I don't want to open a big box here and I don't want to block such > great contributions, but it would be great if we can agree on a single > place where to document these things... Given the long history of our more than 300

Re: Feature Model How-To Series Proposal

2020-06-16 Thread Carsten Ziegeler
Hi, I think this is great and definitely needed. I like the proposal! However (and this actually has little to do with your proposal) :) it raises the question of where/how we document things. At least parts are already covered in the feature documentation at: https://github.com/apache/sling