Merge pull request #26 from OvertureMaps/dev

Merge Dev to main: License update and editorials

.github/PULL_REQUEST_TEMPLATE/documentation_update.md

@@ -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)
+

.github/workflows/github-actions-copy-latest-docs-to-staging.yaml

@@ -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/

.github/workflows/github-actions-copy-pr-docs-to-staging.yaml

@@ -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}}/

docusaurus/README.md

@@ -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
 ```

docusaurus/docs/index.mdx

@@ -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).

docusaurus/docusaurus.config.js

@@ -69,6 +69,7 @@ const config = {
         logo: {
           alt: 'Overture Maps Foundation Logo',
           src: 'img/omf_logo_transparent.png',
+          href: 'https://overturemaps.org'
         },
         items: [
           {

schema/buildings/building.yaml

@@ -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: