Proposed: Publish procedures as markdown

[briesenberg07]

Greetings @gerontakos

I'd like to continue building out the documentation that you've started for schemasProject. I should not spend too much time on this, but I am currently asking and getting answers to a lot of questions about how to use these tools--I may as well add to the documentation as I'm able and while the process is fresh in my mind. I believe that we would do well to have a more complete set of how-to documentation here, even if a revamp is in mind (we don't know when).

I propose using a GitHub wiki to do this. This would mean moving files in procedures/ to a wiki repository and managing separately (GitHub wikis are tracked separately from the repository they are associated with; they are their own repository). This would allow us to write in markdown, not HTML. Writing in markdown is preferable to me for creating documentation.

It did occur to me that the documentation was in HTML because you were, or were planning to, generate it using a transform or the like?

[gerontakos]

At this point, I don't think it matters too much how we do the documentation (html v markdown). The original vision was that all work would be done using web browsers and xml editors. github wiki docs can be viewed in a browser too of course. But I can work with a github wiki, if you prefer that.

[briesenberg07]

Thank you for weighing in @gerontakos ! Since you are amenable I may forge on with the GitHub wiki plan. I'm happy to handle converting existing content to markdown files (a.k.a. copy/paste, and add some # headings and - bullets, organize a bit, etc.).

[briesenberg07]

@gerontakos I converted draft procedure files to markdown. Content is unchanged for the time being. I reproduced most HTML formatting (and added some additional formatting) in markdown. Some additional details:

• A README was created and includes a tagline and links to documentation, which can be viewed in a browser without opening local copies of HTML files.
• I placed markdown files in procedures/, not in a wiki, because I like using HackMD to edit and push changes and this isn't possible with GitHub wikis
• Documentation can be edited by pulling/pushing from/to master, or using HackMD (I can provide info on this if it is something you are interested in).