Add info about contributing to README

[bryanwweber]

Add info about how to add blog posts and new pages to the README, and possibly also a CONTRIBUTING file

[ischoegl]

That addition would be quite helpful. Also, are there portions that are generated by sphinx, doxygen, etc?

[bryanwweber]

Everything in this repository is generated by Nikola. We upload documentation of every build of the master branch of Cantera/cantera into a folder on the website, that documentation is built by Sphinx and managed by the Cantera/cantera Travis builds.

[ischoegl]

Everything in this repository is generated by Nikola.

... except for rst files in pages/science, correct? I.e. those are still edited manually.

[bryanwweber]

Hmm, yes I was not very precise. Technically, Nikola doesn't generate anything that is checked into this repo. Nikola processes all of the reST and Markdown files (which are checked into the repo) into HTML, and uses some custom plugins to process the examples. All of the reST and Markdown files must be edited to change the content.

[ischoegl]

Following up on my comment from the other thread here: assuming that it is possible to pull reST files (specifically science docs) from another repo (e.g. cantera/docs), then you should be able to have two versions as currently being discussed? If it is indeed possible to have Nikola pull that content in from a dedicated reST repo, it would then be possible to replicate the branch structure from the code repo (with branch 2.4 and master for stable cantera and cantera-devel). Hooking the two versions into the website shouldn't be an issue. I hope this cleared up my earlier comment.

From the perspective of documentation, it would be imho much simpler to write something with a single audience, rather than having to always think about who's using what version. From the perspective of readers, it will hopefully also avoid some confusion. I will not comment on the other thread as I need to get out of this conversation.