[wildfly-dev] One Doc to Rule Them All

[James Perkins]

On Fri, Jul 29, 2016 at 6:42 AM, Carl Harris <ceharris414 at me.com> wrote:

>
> On Jul 25, 2016, at 1:40 PM, James Perkins <jperkins at redhat.com> wrote:
>
> Anyway, I'm up for anything that allows the documentation to be
>> consistent, easy to write and easy to use. The main attraction for me to
>> asciidoc is being able to use git for versioning as well as being able to
>> use variables. I don't however know how well asciidoc deals with multiple
>> documents and combining them together.
>>
>
> This has probably already been mentioned somewhere in this thread, but a
> related advantage to an asciidoc (or similar) approach using git, is that
> you can more easily take documentation contributions in the form of pull
> requests. I often find myself wanting to suggest a revision, especially
> after figuring out how to do something that wasn't clearly explained, but
> apart from adding comments to the page (which are difficult to put in
> context), there is no good way to suggest revisions in Confluence.
>
>
This is something I didn't consider. Thank you for pointing it out.

Out of curiosity is there a reason you don't want to just update the
document itself?


> carl
>
> _______________________________________________
> wildfly-dev mailing list
> wildfly-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/wildfly-dev
>



-- 
James R. Perkins
JBoss by Red Hat
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.jboss.org/pipermail/wildfly-dev/attachments/20160729/3084f1b4/attachment.html