oss-generic / process

The OSS-Generic Reference Process
https://oss-generic.github.io/process/
MIT License
6 stars 19 forks source link

Convert docs from markdown to asciidoc #92 #93

Closed pyokagan closed 7 years ago

pyokagan commented 7 years ago

Fixes #92

Convert our documentation from markdown to asciidoc format, in order to
take advantage of the additional features and semantic elements that
asciidoc offers such as automatic section numbering, admonitions and
automatic table of contents (TOC) generation.

Implement a simple build+deployment system to automatically publish our
documentation to https://oss-generic.github.io/process/

The result (based on the tip of this PR) can be seen at https://pyokagan.github.io/oss-generic-process/ Please help to proof-read it! (Might make for some nice bedtime reading)

Note that the main goal of the PR is to convert the bulk documentation to asciidoc, so I'd rather not spend too much time on the build system aspect of this PR (e.g. using a full-featured static website generator or more advanced templating etc.) More advanced enhancements can be done later by someone else.

damithc commented 7 years ago

Nice. Let me know when you expect some input from me.

CanIHasReview-bot commented 7 years ago

v1

@pyokagan submitted v1 for review.

(:books: Archive)

Checkout this PR version locally ```sh git fetch https://github.com/oss-generic/process.git refs/pr/93/1/head:BRANCHNAME ``` where `BRANCHNAME` is the name of the local branch you wish to fetch this PR to.
pyokagan commented 7 years ago

+cc documentation authors @Skaty @li-kai @AngShiYa @chao1995 @yamgent @acjh

damithc commented 7 years ago

I forgot to add: Some of the the // TODO fillers in the previous version seem to have disappeared, resulting in section titles without any body.

pyokagan commented 7 years ago

@damithc

Some of the the // TODO fillers in the previous version seem to have disappeared, resulting in section titles without any body.

OK.

CanIHasReview-bot commented 7 years ago

v2

@pyokagan submitted v2 for review.

(:books: Archive) (:chart_with_upwards_trend: Interdiff between v1 and v2)

Checkout this PR version locally ```sh git fetch https://github.com/oss-generic/process.git refs/pr/93/2/head:BRANCHNAME ``` where `BRANCHNAME` is the name of the local branch you wish to fetch this PR to.
pyokagan commented 7 years ago

v2

TIL: :trollface: isn't an actual unicode emoji :trollface: I used an image instead.

pyokagan commented 7 years ago

@damithc Done. You'll need to set up Travis CI on this repo with the GITHUB_TOKEN environment variable set to a personal access token of an account which can push to this repo. The usual stuff :-)