Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Approach #98

Closed
KipTwitchell opened this issue Feb 17, 2021 · 7 comments
Closed

Documentation Approach #98

KipTwitchell opened this issue Feb 17, 2021 · 7 comments
Assignees
Labels

Comments

@KipTwitchell
Copy link
Member

It is proposed that we consider use of Gatsby as the documentation tooling for web presentation. To be discussed at the TSC meeting in Feb.

Discussion should be had on User's Guide, Reference, Developer Guide, Impact, Design, etc.

Additional discussion to be held on DITA vs. MD as well.

@KipTwitchell
Copy link
Member Author

KipTwitchell commented Mar 10, 2021

TSC meeting discussion: question to Ian as to what the production ready process rather than if this is a prototype effort at this point.

Eugene walked the team through the choices between DITA to Markdown. His recommendation was to use Markdown as the approach we would use, primarily because of the possible of additional resources to help with documentation. Decision is made on Markdown.

@SaPeresi
Copy link
Member

Ian would like to demo the website.

@AOrthVector
Copy link
Contributor

Here's the link to the artwork created by OPM
https://github.com/openmainframeproject/artwork/tree/main/projects/genevaers

They are in the standard formats including svg

@SaPeresi
Copy link
Member

discussed creating more data for orders to show large amount.

@KipTwitchell
Copy link
Member Author

Looking for push of Gatsby pieces by the May 1st meeting. MIT license question about acknowledgment, Kip to Investigate that need.

@KipTwitchell
Copy link
Member Author

Can this issue be close?

@emorrow38
Copy link

Yes, we can close this issue. Gatsby is most definitely the tool for our main documentation site the "GenevaERS General Documentation" website. The advantages are:

  1. It's free.
  2. It handles 1000+ topics very well - there are two navigation sidebars on the screen. The left sidebar allows users to find a topic anywhere in the tree. The right sidebar allows navigation inside a topic if there are a lot of headings in the topic.

So this issue can be closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants