Skip to content
This repository was archived by the owner on May 28, 2021. It is now read-only.

Commit d417c9c

Browse files
committedJan 26, 2021
adds
1 parent e08d475 commit d417c9c

File tree

14 files changed

+96
-1
lines changed

14 files changed

+96
-1
lines changed
 

‎.gitignore

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Pipfile
2+
target/
3+
site/
4+
venv/
5+
docs/*md
6+
docs/types/
7+
*/my_schema.*

‎MAINTAINERS.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# How to make a release
2+
3+
See the instructions at the top of [Makefile](Makefile)
4+
5+
First install the linkml python package and mkdocs:
6+
7+
```bash
8+
. environment.sh
9+
pip install -r requirements.txt
10+
```
11+
12+
Then every time you change the source schema, run:
13+
14+
```bash
15+
make all
16+
```
17+
18+
This will generate files in:
19+
20+
* [docs]
21+
* [jsonschema]
22+
* [shex]
23+
* [owl]
24+
* [rdf]
25+
26+
Do **not** git add the files in docs
27+
28+
Once the files are generated, run
29+
30+
```bash
31+
make gh-deploy
32+
```
33+
34+
Your documentation will be available from a URL https://my_org_or_name.github.io/my_schema/
35+

‎README.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Template for LinkML schema repos
2+
3+
How to use this repository:
4+
5+
## Initial setup
6+
7+
1. Clone this repository in GitHub
8+
2. Modify this file (README.md) to have a *brief* description of your project
9+
3. Rename the schema file in [src/schema](src/schema). Keep the `.linkml.yaml` suffix
10+
4. Add your repo to GitHub
11+
12+
## Making Releases
13+

‎csv/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Python
2+
3+
Do not edit the files in here - these are autogenerated from the schema. See the Makefile for details.

‎docs/README.txt

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Auto-generated docs
2+
3+
Do **not** edit docs here. Instead edit files in src/docs. All other docs are autogenerated
4+

‎environment.sh

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#!/bin/sh
2+
python3 -m venv venv
3+
source venv/bin/activate
4+
export PYTHONPATH=./
5+

‎graphql/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Python
2+
3+
Do not edit the files in here - these are autogenerated from the schema. See the Makefile for details.

‎jsonschema/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# JSON-Schema
2+
3+
[JSON Schema](https://json-schema.org/) is a schema language for JSON documents
4+
5+
Do not edit the files in here - these are autogenerated from the schema. See the Makefile for details.

‎mkdocs.yml

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
site_name: "{{schema.description}}"
22
theme: readthedocs
33
nav:
4-
- Home: index.md
4+
- Home: home.md
5+
- Index: index.md
6+
- Credits: credits.md

‎owl/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# OWL
2+
3+
Web Ontology Language [OWL](https://www.w3.org/TR/2012/REC-owl2-overview-20121211/)
4+
5+
Do not edit the files in here - these are autogenerated from the schema. See the Makefile for details.

‎python/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Python
2+
3+
Do not edit the files in here - these are autogenerated from the schema. See the Makefile for details.

‎rdf/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# RDF
2+
3+
Do not edit the files in here - these are autogenerated from the schema. See the Makefile for details.

‎shex/README.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# ShEx
2+
3+
Schema rendered as [ShEx](http://shex.io/shex-semantics/index.html) - Shape Expressions Langauge
4+
5+
Do not edit the files in here - these are autogenerated from the schema. See the Makefile for details.
6+
7+
File renamed without changes.

0 commit comments

Comments
 (0)
This repository has been archived.