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

Merge Dev to main: License update and editorials #26

Merged
merged 12 commits into from
Jul 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 0 additions & 54 deletions .github/ISSUE_TEMPLATE/agenda-minutes-template.md

This file was deleted.

4 changes: 4 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/documentation_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Update to the Schema Documentation Website

To view the changes this PR introduces to the documentation website, view the [https://dfhx9f55j8eg5.cloudfront.net/pr/<PUT THE PR # HERE>](Page Preview)

Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ jobs:
- name: Fetch AWS credentials
uses: aws-actions/configure-aws-credentials@v2
with:
role-to-assume: arn:aws:iam::207370808101:role/Overture_GitHub_schema-wg_Publish_Docs_Staging
role-to-assume: arn:aws:iam::207370808101:role/Overture_GitHub_schema_Publish_Docs_Staging
aws-region: us-east-2

- name: Copy Docusaurus website to staging bucket /latest/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:
- name: Fetch AWS credentials
uses: aws-actions/configure-aws-credentials@v2
with:
role-to-assume: arn:aws:iam::207370808101:role/Overture_GitHub_schema-wg_Publish_Docs_Staging
role-to-assume: arn:aws:iam::207370808101:role/Overture_GitHub_schema_Publish_Docs_Staging
aws-region: us-east-2

- name: Copy Docusaurus website to staging bucket /pr/${{github.event.number}}/
Expand Down
23 changes: 8 additions & 15 deletions docusaurus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,34 +21,27 @@ Then, start the local server:
```
$ npm run start
```
This command does 2 things: First, it copies the contents of `schema/` into `docusaurus/docs/yaml`, then it runs the docusaurus server which reads the contents of `docs/overture-schema` pages and the `docs/yaml` files to build the page.
This command does 2 things: First, it copies the contents of `schema/` into `docusaurus/docs/_schema`, and `examples/` into `docusaurus/docs/_examples`, then it runs the docusaurus server which builds the documentation.

This command should also launch a browser window to `http://localhost:3000` where any changes to the source `.mdx` files are reflected live.

### Editing
All of the relevant editable `.mdx` files are here:
```
schema-wg/
schema/
docusaurus/
docs/
overture-schema/
-schema.mdx
Addresses/
-address.mdx
Buildings/
-footprint.mdx
gers/
reference/
themes/
index.mdx
```
These files may contain the headings, examples, etc. for each schema file, in markdown.

Adding descriptions to the actual schema elements, however, should be done in the schema YAML files directly in the main (`schema-wg/schema/`) directory.

_Note: each time you run `npm run start`, the official YAML schema files from `schema-wg/schema` are copied to the `docusaurus/docs/yaml` directory, where docusaurus parses them._

### Adding a new Schema Page
1. Update the `src/YAML_FILE_TREE.js` file to include the _relative_ path to the YAML file.
2. Add a new `.mdx` file in the `docs/overture-schema` directory.
Adding descriptions to the actual schema elements, however, should be done in the schema YAML files directly in the main (`schema/`) directory.

_Note: each time you run `npm run start`, the official YAML schema files from `/schema` are copied to the `docusaurus/docs/_schema_` directory, where docusaurus parses them._

## Publishing
```
Expand Down
3 changes: 2 additions & 1 deletion docusaurus/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,5 @@ less common use cases ("the periphery") via extensibility.
4. Feature Geometries follow the [OGC Simple Feature Access specifications](https://www.ogc.org/standard/sfa/).
5. Measurements use SI units (e.g. meters for building heights) and local units for regulations and restrictions (e.g. speed limits in mph in the US and km/h in Germany).

Copyright © Overture Maps Foundation, 2023
## License
Overture Maps Schema is licensed under [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/legalcode).
1 change: 1 addition & 0 deletions docusaurus/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ const config = {
logo: {
alt: 'Overture Maps Foundation Logo',
src: 'img/omf_logo_transparent.png',
href: 'https://overturemaps.org'
},
items: [
{
Expand Down
2 changes: 1 addition & 1 deletion schema/buildings/building.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ type: object
properties:
geometry:
description: >-
A regular building's geometry is deinfed as it's footprint or roofprint (if traced from aerial/satellite imagery). These MUST be a Polygon as defined by GeoJSON
A regular building's geometry is defined as it's footprint or roofprint (if traced from aerial/satellite imagery). These MUST be a Polygon as defined by GeoJSON
schema.
unevaluatedProperties: false
oneOf:
Expand Down
3 changes: 0 additions & 3 deletions submission_process.svg

This file was deleted.