Update all technical documentation

[opoudjis]

And remove all technical documentation from README of individual gems where it can go to metanorma.com instead.

[opoudjis]

Transferred all information from gem READMEs. Next, will go through all docs/* documents (though I have not been updating them, so that will be quick.) Then, will do global review.

[strogonoff]

Hope you don’t end up redoing what I’ve done while writing new documentation based on gem READMEs and wikis prior ;)

[strogonoff]

Feel free to omit phrasing changes, unless there’s an obvious typo or mistake. Also you can just file issues instead of PRs to save own time.

[opoudjis]

I feel I need to do writing at this stage, as a global review. PRs are messy, but it's a finite project.

[opoudjis]

@strogonoff I'm looking at the remaining documentation in docs/*, and I'm seeing that unlike its siblings (which I've already deleted), metanorma-standoc/docs/quickstart.adoc has not been migrated to metanorma.adoc. I'm assuming that's because its content is fairly similar to metanorma.com/author/topics/document-format. I still think it would be useful to port, since it is a quick summary of Asciidoctor markup, whereas the main discussion in metanorma.com is more expansive.

[strogonoff]

Thanks Nick! Let me take a look at StanDoc docs here and see how authoring docs on the site can benefit from it. We do want some more quickstart-ish tutorials there currently. (I won’t say I’ll port everything since excess content is a bit of a liability—links have to be maintained, etc.—but I’ll see if docs here can fill in some of the gaps)

On May 31, 2019, at 6:27 PM, Nick Nicholas notifications@github.com wrote:

@strogonoff https://github.com/strogonoff I'm looking at the remaining documentation in docs/*, and I'm seeing that unlike its siblings (which I've already deleted), metanorma-standoc/docs/quickstart.adoc has not been migrated to metanorma.adoc. I'm assuming that's because its content is fairly similar to metanorma.com/author/topics/document-format. I still think it would be useful to port, since it is a quick summary of Asciidoctor markup, whereas the main discussion in metanorma.com is more expansive.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/metanorma/metanorma.com/issues/72?email_source=notifications&email_token=AACHQX3KYNVMYLSESMDI5ZLPYD4QZA5CNFSM4G44FIO2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODWU3HTA#issuecomment-497660876, or mute the thread https://github.com/notifications/unsubscribe-auth/AACHQXZLXE3EZ2GJSXQC7ITPYD4QZANCNFSM4G44FIOQ.

[opoudjis]

The following are the remaining docs/* files that are candidates for merger into metanorma.com, and I would rather assign this task to you. There are several instances of quickstarts, and there is documentation for tools that has not yet been incorporated into metanorma.com.

In addition, NIST documentation has not been added to metanorma.com; @ronaldtse, is there still a reason why it should not be?

metanorma-cli/docs:
installation.adoc   navigation.adoc     usage.adoc

metanorma-csd/docs:
navigation.adoc quickstart.adoc

metanorma-ietf/docs:
installation.md navigation.md   overview.md

metanorma-iso/docs:
asciiiso-syntax.adoc    guidance.adoc       navigation.adoc     quickstart.adoc

metanorma-standoc/docs:
quickstart.adoc

relaton-bib/docs:
hash.adoc

relaton-cli/docs:
README.adoc navigation.adoc

relaton/docs:
README.adoc navigation.adoc

[ronaldtse]

@opoudjis documentation of enterprise versions will be setup to a private site.

[ronaldtse]

@strogonoff could you help handle the list given by @opoudjis ? Thanks!