Submit a pull request back to the main repo Make the at using their nice web-based gitbook interface Right now we could ask them to use the gitbook interface But I am not sure yet what the best option is for a simple UI for the drive by editors. These people will probably want to take advantage of desktop editors and so on, and might be branching and merging in git.įor better or worse, the vast majority of people in our current documentation community fit into this second category and I think they will be well served by this move since they will have a lot of options to choose from (both desktop and web-based). Large and ongoing edits by power editors. Or more generally, how can we make it as easy as possible for people to contribute to documentation? I think we have two broad types of editors that we want to encourage.ĭrive by edits from people who want to quickly make a correction or add some missing info - these people want a simple login to a web based interface. What about the user friendly editor interface? I think the obvious approach is for each extension to get its own repository which can then be registered somehow on so we can create a library of extension documentation.
Anyone have experience of similar documentation projects and how they do their translations? I suspect that they have a fairly well developed procedure for handling the translation and updates of their documentation that we could learn from. Symfony also store their documentation in github and have parallel repositories for each language e.g. Some areas we need to think through some more, with some initial thoughts: Each part of the book is a directory and each of the chapters in that part are files in that directory.
#Gitbook editor code#
You can see the source code that creates this book here. It is an alpha - lots to neaten up and lots of details to work out, but a good starting point for discussion. You can see the result here: (this link will likely stop working once we find it a proper home). I wrote a simple script that takes output from booki (our current tool) and turns it into something suitable for gitbook.
#Gitbook editor free#
Gitbook "Modern book format and toolchain using Git and Markdown" seemed to tick a lot of boxes and so (while waiting for my plane at Denver airport) I thought I would take advantage of the free wifi and give it a test drive. Uses widely used standards that will outlive any particular platform choices we makeįollowing a few different conversations at different sprints over the years we grew fond of the idea of markdown stored in a git repository as a solid base that will help us meet many of the above requirements and started to look for a set of open source tools that would allow us to do this.
#Gitbook editor manual#
Translation infrastructure, so that our language communities can easily create different language versions of the manual, and can easily keep these up to date when the manual is updatedĬan handle growing documentation needs (including end user documentation for extensions) Version control so that people can work on different 'branches' of the documentation at the same time (that we can merge independently when ready for publication)
#Gitbook editor pdf#
Produces a 'good looking' html version of the bookĪbility to export to different format (including ebook and pdf and output suitable for traditional publishing) Simple user interface that makes it easy for people to contribute We'd like to move the guide somewhere that has better support for more of the features that we want, which include For a while we have been thinking about some new infrastructure for CiviCRM's user and administrator documentation.
0 kommentar(er)
