search

RadicalMilitantLibrary / manual

A helpful documentation for all of you that are willing to rise from ordinary Reader to Librarian or are eager to know sligtly more about this place and how it works.
https://gitlab.com/lazy-book-crowd/jrc-manual
Creative Commons Attribution Share Alike 4.0 International
3 stars 2 forks source link

continuous integration #11

Closed vv01f closed 7 years ago

vv01f commented 7 years ago

right now and with each change online again the manual release (PDF, ODT, EPUB, …) deployed on the library is outdated; for users it is maybe not easy to get a build running themselves and pulling in a version once (like authors and devs) in a while someone has to take care of this; but those want it to be as easy as possible after putting all the tools on their machines => automation likely helps in the long term

problems:

  1. needs build system somewhere maintained
  2. changes might need approval so not every change is pulled on site
  3. no revision number with git, just a chaos of sha1 and metadata

solutions

  1. circumvent and just display markdown version nicely online, e.g. with a php parser
  2. well, can be done either locally or on a server or a VM if isolation is intended; server solutions both might be hosted separately but best reachable via tor
  3. tagging on a revision we (see problem 3)
  4. git enables us to have a commit hash instead of an ever growing revision number (formerly used with svn), this one can collide, so it is better to refer to a date-time combined and tag the manual on a "version" with a tool to automatically build a certain release.

todo

or (optional)

ewa4boeker commented 7 years ago

nice approach, but overkill for the manual here. if anyone has it running it might still be used, just no importance to it.