On 1 Aug 2014, at 17:46, Rafael Benevides <benevi...@redhat.com> wrote:
> Hi all, > > As you may known, Red Hat docs team was called to help on DeltaSpike docs. > After a long period, they have analyzed the documentation and bring us an > awesome plan that is available here: > https://docs.google.com/document/d/186f_amQ9XuREq8FcO7orxvOjQZtvEEYa7WPj1e8p8bM/edit#heading=h.4sqhyz68wgg2 > > The document is opened for comments. > > Something that was also discussed not only inside Red Hat but with some > community members is about the format and source of the documentation. I > strongly believe that we should have the documentation somewhere else but the > DS site source. It could improve the ease to the community to contribute with > it. Having said that, it's also suggested that we should use asciidoc as > documentation format. > > So what we have until now ? > > - The documentation plan to be reviewed and approved by the DS community. > Then we can talk about the plans to make it happen. +1 for the content changes, whatever else. This is the most important thing for the wider community IMO. > - The documentation location: Recommendation to be out of the site source. This would be nice. It can then be imported by e.g. an svn submodule or git checkout as part of the site build > - The documentation format: Suggested to use asciidoc. +1 asciidoc is really nice, it allows you do a lot of stuff you would like to do in markdown (e.g. tables) but can’t without non-standard extensions. > > Please, read the plan and lets discuss about these 3 topics individually. > > Michelle Murray (whose team provided the plan and she is copied on this > Thread) can follow the feedback. > -- > > Rafael Benevides | Senior Software Engineer > JBoss Developer > M: +55-61-9269-6576 > > <{a8aabf3a-4467-4e37-9bc5-48b1d7b494a2}_LATAM_RedHat.jpg> > > Better technology. Faster innovation. Powered by community collaboration. > See how it works at www.redhat.com > > <linkedin.png> <youtube.png>
