Re: Fedora Publishing

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

On 02/05/2016 11:34 PM, Dylan Combs wrote:
> (2) tooling that worked like a git/pull-request model?

As a developer I am really opposed to inflicting git's pull/request work flows on Humans. IMO docs and code have a highly divergent set of attributes and what makes git good for code doesn't help at all with docs, in
fact the complexity of git work flow is just a barrier to entry for a lot of potential docs contributors.

My suggestion, FWIW, is to use something like stackedit [1] with couchdb.

The tooling being Fedora hosting an instance of stackedit, couchdb, and one of the publishing tools (probably ssh).

The whole stack is Open Source, have active up-streams, and can be self hosted. While there is a service that accepts publishing, the content delivered to users is static, thus keeping Ops on side.

Authors just sync, edit, save, repeat, and then someone with ssh access does a publish.

It's very close to a wiki work flow, but with a little extra flexibility.

If you want multiple formats on the site then that should happen after the publish, the publisher should not have to do anything. This separates formatting from authoring completely which is an unnecessary burden authors
currently carry.

If people want to edit in a different format, then they export to disk, use pandoc or some other tool to convert to and from their chosen format.

You can use the same disk import/export process for off line work.

Getting all the current docs in to couchdb would be easy, Publican will happily generate the markdown which you import from disk in to stackedit and save to couchdb.

CouchDB can keep how ever many revisions of a doc you want, so old revisions can be kept around forever if you want.

The other benefit is that if you eventually want to get a cutting edge website, say using markdown.js or react.js, then you can feed either couchdb or the published markdown in to them without any change in behaviour
from the authors. Transparent front end changes FTW!

Cheers, Jeff.

1: https://stackedit.io/editor#

- -- 
Jeff Fearn
Senior Software Engineer
PnT - DevOps - Development
Red Hat Asia Pacific Pty Ltd
http://dilbert.com/fast/2004-08-17/
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2

iQEcBAEBCAAGBQJWt9SLAAoJELs3R4zxGZvKjBUH/jiOpgEI1cCu7ccnJ6At7EGa
jLQbItv5uBtBj7kRSy2+nvH/80GTBykeUtGjwuI55z7FWPJgZMQSiQeGVv3sJUXY
0tC3A1/Sh3zSJU3DdYW1kE/qxZ7liZuV1o67au4+N8PrA9aQZGD0i8zYbmdTtadz
tsJBQsyO7LIHuWY/P6wYYP4sru3/wn7TjVB715eUxoeF2RtZg8a17P7tumxUMKMY
f2298Qt8EyMJVmXEewuhCvc6knAYmWUETHQ3XKVkFD0zCISoerE+lyfDrdYRkYyA
RblEvpkdH/+Mq5hZTmS5VQ+bgc6jpyGWIBsS26WYiQ0fkTUBURHdcT551zG4mPw=
=02/7
-----END PGP SIGNATURE-----
--
docs mailing list
docs@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe:
http://lists.fedoraproject.org/admin/lists/docs@xxxxxxxxxxxxxxxxxxxxxxx




[Index of Archives]     [Fedora Users]     [Fedora Desktop]     [Red Hat 9]     [Yosemite News]     [KDE Users]

  Powered by Linux