<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
</head>
<body text="#000000" bgcolor="#FFFFFF">
<p>Hi there, <br>
</p>
<div class="moz-forward-container">I'm compiling these replies to
help with the new intro for the FM manual. I had a comment in
relation to this one. <br>
</div>
<div class="moz-forward-container">"Michael, I imagine there is
something about the familiarity of contributing 'code' / docs via
a git pull request -- for those familiar with the process -- which
for many may be less intimidating than the social process of
reaching out to an unknown community on an email list or forum, or
just getting stuck in"</div>
<div class="moz-forward-container"><br>
nice one</div>
<div class="moz-forward-container">Mick<br>
<blockquote type="cite"
cite="mid:fc1d9865-a869-cded-7076-aef5d75ac713@flossmanuals.net">
<div class="moz-cite-prefix">On 16/05/2019 20:00, <a
class="moz-txt-link-abbreviated"
href="mailto:michaelmcandrew@thirdsectordesign.org"
moz-do-not-send="true">michaelmcandrew@thirdsectordesign.org</a>
wrote:<br>
</div>
<blockquote type="cite"
cite="mid:83bfd98015ec8dd0f1808c6031e028f6b4e2ed47.camel@thirdsectordesign.org">
<meta http-equiv="content-type" content="text/html;
charset=UTF-8">
<div>Hey Mick,</div>
<div><br>
</div>
<div>Nice to hear from you. CiviCRM 'abandoned' FM a few years
ago (sorry about that!) in favour of read the docs based on
markdown in git repos.</div>
<div><br>
</div>
<div>git and markdown is significantly more techy and while
this might have prevented a few non technical people from
contributing, the number and quality of our contributions to
documentation has increased considerably - that's the nature
of our community, I guess.</div>
<div><br>
</div>
<div>Also, I use jekyll for company and personal
documentation. I love the simplicity and flexibility.</div>
<div><br>
</div>
<div>Hope you are well and that that is somewhat useful.</div>
<div><br>
</div>
<div>Michael</div>
<div><br>
</div>
<div>On Tue, 2019-05-14 at 09:24 +0100, <a
class="moz-txt-link-abbreviated"
href="mailto:mick@flossmanuals.net" moz-do-not-send="true">mick@flossmanuals.net</a>
wrote:</div>
<blockquote type="cite" style="margin:0 0 0 .8ex;
border-left:2px #729fcf solid;padding-left:1ex"><br>
<div class="moz-forward-container"><br>
</div>
<div class="moz-forward-container">-------- Forwarded
Message --------
<table class="moz-email-headers-table" cellspacing="0"
cellpadding="0" border="0">
<tbody>
<tr>
<th valign="BASELINE" nowrap="nowrap" align="RIGHT">Subject:
</th>
<td>[FM Discuss] When to use FLOSS Manuals and when
it's not the best tool / platform? your opinions</td>
</tr>
<tr>
<th valign="BASELINE" nowrap="nowrap" align="RIGHT">Date:
</th>
<td>Tue, 14 May 2019 09:11:15 +0100</td>
</tr>
<tr>
<th valign="BASELINE" nowrap="nowrap" align="RIGHT">From:
</th>
<td><a class="moz-txt-link-abbreviated"
href="mailto:mick@flossmanuals.net"
moz-do-not-send="true">mick@flossmanuals.net</a>
<a class="moz-txt-link-rfc2396E"
href="mailto:mick@flossmanuals.net"
moz-do-not-send="true"><mick@flossmanuals.net></a></td>
</tr>
<tr>
<th valign="BASELINE" nowrap="nowrap" align="RIGHT">Reply-To:
</th>
<td><a class="moz-txt-link-abbreviated"
href="mailto:discuss@lists.flossmanuals.net"
moz-do-not-send="true">discuss@lists.flossmanuals.net</a></td>
</tr>
<tr>
<th valign="BASELINE" nowrap="nowrap" align="RIGHT">To:
</th>
<td><a class="moz-txt-link-abbreviated"
href="mailto:discuss@lists.flossmanuals.net"
moz-do-not-send="true">discuss@lists.flossmanuals.net</a></td>
</tr>
</tbody>
</table>
<br>
<br>
Hi there,<br>
<br>
For the FLOSS Manual Manual update, It would be great to
get people's<br>
experiences of when a platform like BookType that FM uses
is the best<br>
option for an individual to use for documentation, and
when other tools<br>
are a better fit.<br>
<br>
Times have changed and when Adam Hyde FM started there was
really<br>
nothing out there like it in terms of flexibility and ease
of use for<br>
documentation. Now there are quite a few alternatives.<br>
<br>
* <a class="moz-txt-link-freetext"
href="https://readthedocs.org/" moz-do-not-send="true">https://readthedocs.org/</a>
(in combination with <a class="moz-txt-link-freetext"
href="https://www.sphinx-doc.org/_"
moz-do-not-send="true">https://www.sphinx-doc.org/_</a><br>
* git books - and git pages - <a
class="moz-txt-link-freetext"
href="https://www.gitbook.com/" moz-do-not-send="true">https://www.gitbook.com/</a><br>
* some kind of static site generator using Jamstack / Hugo
/ Jekyll or<br>
similar using mark-up source files<br>
* other solutions<br>
<br>
I'd be interested to know if people on this list who used
to use FLOSS<br>
Manuals but now use something else would like to comment
on the pros and<br>
cos. The purpose is to write a chapter that helps people
evaluate if FM<br>
is the right place for them. Some of the factors might
be...<br>
<br>
* ease of use, pros and cos of using WYSIWYG<br>
* limits to version control<br>
* translations<br>
* issues around communities and particular needs /
expectations<br>
<br>
One thing, it would be great not to focus on past /
current issues of<br>
using BookType. If you have bug reports or feature
requests it would be<br>
great to put them here instead.<br>
<a class="moz-txt-link-freetext"
href="https://gitlab.com/flossmanuals/fm_booktype"
moz-do-not-send="true">https://gitlab.com/flossmanuals/fm_booktype</a><br>
<br>
But even if there's an overlap, then please chip in!<br>
<br>
nice one!<br>
<br>
Mick</div>
</blockquote>
</blockquote>
</blockquote>
</div>
</body>
</html>