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

set up github.io with schema as markdown (input for mkdocs) #66

Open
2 tasks
dosumis opened this issue Mar 18, 2021 · 2 comments
Open
2 tasks

set up github.io with schema as markdown (input for mkdocs) #66

dosumis opened this issue Mar 18, 2021 · 2 comments
Assignees
Labels

Comments

@dosumis
Copy link
Collaborator

dosumis commented Mar 18, 2021

Aim: generate browsable, human-readable documentation of DOSDP JSON SCHEMA

  • Research existing auto-documentation options - markdown output preferred, but we could use static html generator if better.
  • ...
@dosumis dosumis self-assigned this Mar 18, 2021
@dosumis dosumis changed the title set up github.io with schema as browsable html set up github.io with schema as markdown (input for mkdocs) Apr 26, 2021
hkir-dev added a commit that referenced this issue May 4, 2021
hkir-dev added a commit that referenced this issue May 4, 2021
hkir-dev added a commit that referenced this issue May 4, 2021
@hkir-dev
Copy link
Collaborator

hkir-dev commented May 4, 2021

First version of the auto-generated documentation exists here
Used jsonschema2md for basic generation and decorated by using a custom config file.
For this task, needed to update (such as adding doc_type etc.) existing schema a little: new schema
Can you share your recommendations for better a documentation.

hkir-dev added a commit that referenced this issue May 4, 2021
hkir-dev added a commit that referenced this issue May 4, 2021
hkir-dev added a commit that referenced this issue May 5, 2021
hkir-dev added a commit that referenced this issue May 5, 2021
@dosumis dosumis added the doc label Jun 17, 2021
@hkir-dev
Copy link
Collaborator

Mkdocs documentation publishing completed: https://incatools.github.io/dead_simple_owl_design_patterns/

Github action is triggered when; new release, updating README.md or files under docs/ (in the master branch only)

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

2 participants