[prev in list] [next in list] [prev in thread] [next in thread]
List: fedora-docs-list
Subject: Re: Tooling, Tooling, Tooling
From: Simon Clark <sclark () fedoraproject ! org>
Date: 2016-09-09 13:28:37
Message-ID: CAPU=h3aYfGQDoy+=JAxxebDjhTuTjGUo6wuooPuj_fLDgbJvEw () mail ! gmail ! com
[Download RAW message or body]
[Attachment #2 (multipart/alternative)]
On 9 September 2016 at 08:34, Sylvia <bhkohane@gmail.com> wrote:
>
> Hello,
>
> Sorry for the late reply and maybe I'm going to ask a silly question
> but... Is it Mallard a programme or a web based tool...?
> If I want to write something... where or how should I do it? Is there any
> specific programmes for it?
>
>
>
> Cheers, and thanks
> Sylvia
>
>
>
>
> On Sun, 2016-09-04 at 17:31 +0530, Tummala Dhanvi wrote:
>
> On Thu, Aug 11, 2016 at 7:04 PM, Brian Exelbierd <bex@pobox.com> wrote:
>
>
> This email is to drive some discussion around $subject. It follows from
> a blog soon to be posted on the Fedora Community blog
> (https://communityblog.fedoraproject.org). The text below is copied
> from that blog:
>
> Tooling, Tooling, Tooling
>
> There was strong consensus around changing to new tools and markups. In
> fact, most of the tooling conversations were held in small groups near
> the end of the meeting. There was a desire to continue to see a drive to
> simpler contribution and publication.
>
>
>
> I also agree with changing to newer tools which makes writing the docs
> a lot simplier.
>
>
>
>
> The only significant question was around the community, upstream
> adoption and contributor base for pintail which is the central tool in
> the new processing flow. People were very concerned that there wasn't
> evidence of enough adoption and contribution to prevent the project from
> being at risk of going either unmaintained or slowly maintained.
>
>
>
>
> First let me briefly explain how the new process works.
>
> * Docs are written in AsciiDoc (https://en.wikipedia.org/wiki/AsciiDoc)
> * Converted to Mallard (http://projectmallard.org/)
> * Publish them using pintail (https://github.com/projectmallard/pintail)
>
> Docs team had came to this conclusion after considering various
> alternatives (https://communityblog.fedoraproject.org/event-report-fedora-docs-fad/,https://communityblog.fedoraproject.org/event-report-fedora-docs-fad/)
>
> AsciiDoc is widely used various projects (http://asciidoc.org/#X6)
>
> Gnome is using Mallard for writing docs
> (https://wiki.gnome.org/DocumentationProject/Contributing#Write_in_Mallard)
>
> I agree to some extent that there is no enough evidence of adoption
> and contribution (Shaun has written 99% of the tools!), but since
> Gnome is adopting Mallard we should feel confident to some extent.
>
> If by chance the Mallard goes unmaintained we could also switch to
> other tools (like Asciidoctor http://asciidoctor.org/) for publishing
> as we write the docs in Asciidoc format. But this method reduces the
> features that we wanted to use.
>
>
> PS: Brian congrats for becoming Fedora's Community Co-ordinator.
>
>
> --
> docs mailing list
> docs@lists.fedoraproject.org
> To unsubscribe:
> https://lists.fedoraproject.org/admin/lists/docs@lists.fedoraproject.org
>
Hi Sylvia,
Mallard is a markup language for writing topic-based documentation. The
Ten Minute Tour at http://projectmallard.org/about/learn/tenminutes shows
how it works.
Simon
[Attachment #5 (text/html)]
<div dir="ltr"><br><div class="gmail_extra"><div class="gmail_quote">On 9 September \
2016 at 08:34, Sylvia <span dir="ltr"><<a href="mailto:bhkohane@gmail.com" \
target="_blank">bhkohane@gmail.com</a>></span> wrote:<br><blockquote \
class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid \
rgb(204,204,204);padding-left:1ex"><div \
bgcolor="#f7f7f7"><div><br></div><div>Hello,</div><div><br></div><div>Sorry for the \
late reply and maybe I'm going to ask a silly question but... Is it Mallard a \
programme or a web based tool...? </div><div>If I want to write something... where \
or how should I do it? Is there any specific programmes for \
it?</div><div><br></div><div><br></div><div><br></div><div>Cheers, and \
thanks</div><span class="gmail-HOEnZb"><font \
color="#888888"><div>Sylvia</div></font></span><div><div \
class="gmail-h5"><div><br></div><div><br></div><div><br></div><div><br></div><div>On \
Sun, 2016-09-04 at 17:31 +0530, Tummala Dhanvi wrote:</div><blockquote \
type="cite"><pre>On Thu, Aug 11, 2016 at 7:04 PM, Brian Exelbierd <<a \
href="mailto:bex@pobox.com" target="_blank">bex@pobox.com</a>> wrote: <blockquote \
type="cite"> This email is to drive some discussion around $subject. It follows from
a blog soon to be posted on the Fedora Community blog
(<a href="https://communityblog.fedoraproject.org" \
target="_blank">https://communityblog.<wbr>fedoraproject.org</a>). The text below is \
copied from that blog:
Tooling, Tooling, Tooling
There was strong consensus around changing to new tools and markups. In
fact, most of the tooling conversations were held in small groups near
the end of the meeting. There was a desire to continue to see a drive to
simpler contribution and publication.
</blockquote>
I also agree with changing to newer tools which makes writing the docs
a lot simplier.
<blockquote type="cite">
The only significant question was around the community, upstream
adoption and contributor base for pintail which is the central tool in
the new processing flow. People were very concerned that there wasn't
evidence of enough adoption and contribution to prevent the project from
being at risk of going either unmaintained or slowly maintained.
</blockquote>
First let me briefly explain how the new process works.
* Docs are written in AsciiDoc (<a href="https://en.wikipedia.org/wiki/AsciiDoc" \
target="_blank">https://en.wikipedia.org/<wbr>wiki/AsciiDoc</a>)
* Converted to Mallard (<a href="http://projectmallard.org/" \
target="_blank">http://projectmallard.org/</a>)
* Publish them using pintail (<a href="https://github.com/projectmallard/pintail" \
target="_blank">https://github.com/<wbr>projectmallard/pintail</a>)
Docs team had came to this conclusion after considering various
alternatives (<a href="https://communityblog.fedoraproject.org/event-report-fedora-docs-fad/" \
target="_blank">https://communityblog.<wbr>fedoraproject.org/event-<wbr>report-fedora-docs-fad/</a>,
<a href="https://communityblog.fedoraproject.org/event-report-fedora-docs-fad/" \
target="_blank">https://communityblog.<wbr>fedoraproject.org/event-<wbr>report-fedora-docs-fad/</a>)
AsciiDoc is widely used various projects (<a href="http://asciidoc.org/#X6" \
target="_blank">http://asciidoc.org/#X6</a>)
Gnome is using Mallard for writing docs
(<a href="https://wiki.gnome.org/DocumentationProject/Contributing#Write_in_Mallard" \
target="_blank">https://wiki.gnome.org/<wbr>DocumentationProject/<wbr>Contributing#Write_in_Mallard</a>)
I agree to some extent that there is no enough evidence of adoption
and contribution (Shaun has written 99% of the tools!), but since
Gnome is adopting Mallard we should feel confident to some extent.
If by chance the Mallard goes unmaintained we could also switch to
other tools (like Asciidoctor <a href="http://asciidoctor.org/" \
target="_blank">http://asciidoctor.org/</a>) for publishing as we write the docs in \
Asciidoc format. But this method reduces the features that we wanted to use.
PS: Brian congrats for becoming Fedora's Community Co-ordinator.
</pre></blockquote></div></div></div><br>--<br>
docs mailing list<br>
<a href="mailto:docs@lists.fedoraproject.org">docs@lists.fedoraproject.org</a><br>
To unsubscribe:<br>
<a href="https://lists.fedoraproject.org/admin/lists/docs@lists.fedoraproject.org" \
rel="noreferrer" target="_blank">https://lists.fedoraproject.<wbr>org/admin/lists/docs@lists.<wbr>fedoraproject.org</a><br></blockquote></div><br></div><div \
class="gmail_extra">Hi Sylvia,<br><br></div><div class="gmail_extra">Mallard is a \
markup language for writing topic-based documentation. The Ten Minute Tour at <a \
href="http://projectmallard.org/about/learn/tenminutes">http://projectmallard.org/about/learn/tenminutes</a> \
shows how it works.<br><br></div><div class="gmail_extra">Simon <br></div></div>
[Attachment #6 (text/plain)]
--
docs mailing list
docs@lists.fedoraproject.org
To unsubscribe:
https://lists.fedoraproject.org/admin/lists/docs@lists.fedoraproject.org
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic