[FM Discuss] When to use FLOSS Manuals and when it's not the best tool / platform? your opinions

[mick at flossmanuals.net]

Hi there,

I'm compiling these replies to help with the new intro for the FM
manual. I had a comment in relation to this one.
"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"

nice one
Mick
> On 16/05/2019 20:00, michaelmcandrew at thirdsectordesign.org wrote:
>> Hey Mick,
>>
>> 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.
>>
>> 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.
>>
>> Also, I use jekyll for company and personal documentation. I love the
>> simplicity and flexibility.
>>
>> Hope you are well and that that is somewhat useful.
>>
>> Michael
>>
>> On Tue, 2019-05-14 at 09:24 +0100, mick at flossmanuals.net wrote:
>>>
>>>
>>> -------- Forwarded Message --------
>>> Subject: 	[FM Discuss] When to use FLOSS Manuals and when it's not
>>> the best tool / platform? your opinions
>>> Date: 	Tue, 14 May 2019 09:11:15 +0100
>>> From: 	mick at flossmanuals.net <mick at flossmanuals.net>
>>> Reply-To: 	discuss at lists.flossmanuals.net
>>> To: 	discuss at lists.flossmanuals.net
>>>
>>>
>>>
>>> Hi there,
>>>
>>> For the FLOSS Manual Manual update, It would be great to get people's
>>> experiences of when a platform like BookType that FM uses is the best
>>> option for an individual to use for documentation, and when other tools
>>> are a better fit.
>>>
>>> Times have changed and when Adam Hyde FM started there was really
>>> nothing out there like it in terms of flexibility and ease of use for
>>> documentation. Now there are quite a few alternatives.
>>>
>>> * https://readthedocs.org/ (in combination with
>>> https://www.sphinx-doc.org/_
>>> * git books - and git pages - https://www.gitbook.com/
>>> * some kind of static site generator using Jamstack / Hugo / Jekyll or
>>> similar using mark-up source files
>>> * other solutions
>>>
>>> I'd be interested to know if people on this list who used to use FLOSS
>>> Manuals but now use something else would like to comment on the pros and
>>> cos. The purpose is to write a chapter that helps people evaluate if FM
>>> is the right place for them. Some of the factors might be...
>>>
>>> * ease of use, pros and cos of using WYSIWYG
>>> * limits to version control
>>> * translations
>>> * issues around communities and particular needs / expectations
>>>
>>> One thing, it would be great not to focus on past / current issues of
>>> using BookType. If you have bug reports or feature requests it would be
>>> great to put them here instead.
>>> https://gitlab.com/flossmanuals/fm_booktype
>>>
>>> But even if there's an overlap, then please chip in!
>>>
>>> nice one!
>>>
>>> Mick
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.flossmanuals.net/pipermail/discuss-flossmanuals.net/attachments/20190528/a8e1fa43/attachment-0001.html>