From c777cca34a1d59df627b6337527b348fdea15758 Mon Sep 17 00:00:00 2001 From: Victor Schappert Date: Fri, 16 Jun 2023 16:52:13 -0700 Subject: [PATCH 1/9] Navigate to main OMF website on docs site logo click This behavior seems to make the most sense intuitively, and it ensures there's a path back to the main Overture Maps website from the docs. --- docusaurus/docusaurus.config.js | 1 + 1 file changed, 1 insertion(+) diff --git a/docusaurus/docusaurus.config.js b/docusaurus/docusaurus.config.js index 950278d6..f31fefcf 100644 --- a/docusaurus/docusaurus.config.js +++ b/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: [ { From 330b90bc31974148b7f5193e3396eaa27e2352f5 Mon Sep 17 00:00:00 2001 From: Victor Schappert Date: Mon, 19 Jun 2023 10:15:53 -0700 Subject: [PATCH 2/9] Update name of IAM Role for staging docs post public release --- .../workflows/github-actions-copy-latest-docs-to-staging.yaml | 2 +- .github/workflows/github-actions-copy-pr-docs-to-staging.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/github-actions-copy-latest-docs-to-staging.yaml b/.github/workflows/github-actions-copy-latest-docs-to-staging.yaml index b9c1b410..d009928b 100644 --- a/.github/workflows/github-actions-copy-latest-docs-to-staging.yaml +++ b/.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/ diff --git a/.github/workflows/github-actions-copy-pr-docs-to-staging.yaml b/.github/workflows/github-actions-copy-pr-docs-to-staging.yaml index 159a489f..2ee70583 100644 --- a/.github/workflows/github-actions-copy-pr-docs-to-staging.yaml +++ b/.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}}/ From 75dfcfedd8000b4ed7469f33ae759510fc408f05 Mon Sep 17 00:00:00 2001 From: Jennings Anderson Date: Thu, 22 Jun 2023 08:04:51 -0700 Subject: [PATCH 3/9] Fixing typo in building.yaml --- schema/buildings/building.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/schema/buildings/building.yaml b/schema/buildings/building.yaml index 5b7e81b9..d300c716 100644 --- a/schema/buildings/building.yaml +++ b/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: From 3909506ad2767c652428eb516a23a6ea14577d9c Mon Sep 17 00:00:00 2001 From: Jennings Anderson Date: Thu, 22 Jun 2023 08:23:22 -0700 Subject: [PATCH 4/9] Delete submission_process.svg --- submission_process.svg | 3 --- 1 file changed, 3 deletions(-) delete mode 100644 submission_process.svg diff --git a/submission_process.svg b/submission_process.svg deleted file mode 100644 index d00fb250..00000000 --- a/submission_process.svg +++ /dev/null @@ -1,3 +0,0 @@ - - -
Rel v1.0
Rel v1.0
Rel v1.1
Rel v1.1
Rel v1.1.1
Rel v1.1.1
Releases
Releas...
Members
Members
Maintainer
Maintainer
Chair
Chair
merged by WG Chair
merged by WG Chair
...
...
merged by WG Chair
merged by WG Chair
?
?
NO
NO
Discussion
Discussion
PR
PR
?
?
NO
NO
Discussion
Discussion
PR
PR
GitHub Flow
GitHub Flow
"main"
"main"
merged by maintainer
merged by mainta...
merged by maintainer
merged by mainta...
"feature-branch-1"
"feature-branch-1"
"feature-branch-x"
"feature-branch-x"
Same process, merge back into "main"
Same process, merge back into "main"
WG Review
&
Approval
WG Review...
Roles:
Roles:Viewer does not support full SVG 1.1 From 9eaac836248ff0882e629c4beefc9eae1b3072ec Mon Sep 17 00:00:00 2001 From: Jennings Anderson Date: Thu, 22 Jun 2023 08:56:34 -0700 Subject: [PATCH 5/9] Delete agenda-minutes-template.md --- .../ISSUE_TEMPLATE/agenda-minutes-template.md | 54 ------------------- 1 file changed, 54 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/agenda-minutes-template.md diff --git a/.github/ISSUE_TEMPLATE/agenda-minutes-template.md b/.github/ISSUE_TEMPLATE/agenda-minutes-template.md deleted file mode 100644 index 3881bfe7..00000000 --- a/.github/ISSUE_TEMPLATE/agenda-minutes-template.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -name: Agenda/Minutes Template -about: Agenda/Minutes Template -title: '' -labels: Agenda/Minutes -assignees: '' - ---- - -## Date: 2023 mm dd -Time 3:00pm UTC - See the time in your timezone https://everytimezone.com/s/a8399b00 - -- Co-Chair Rob Soetewey (TomTom) -- Co-Chair Assaji Aluwihare (Amazon) -- Convener Sean Mcilroy (Linux Foundation) - -## Meeting notices - -### Antitrust Policy - -The Steering Members, General Members, and Contributors acknowledge that they may compete with one another in various lines of business and that it is therefore imperative that they and their respective representatives act in a manner that does not violate any applicable antitrust laws and regulations. Each Steering Member, General Member, and Contributor may have similar agreements with others. Each Steering Member, General Member, and Contributor may design, develop, manufacture, acquire or market competitive deliverables, products and services, and conduct its business, in whatever way it chooses. No Steering Member, General Member, or Contributor is obligated to announce or market any products or services associated with or based on the Project. Without limiting the generality of the foregoing, the Steering Members, General Members, and Contributors agree not to have any discussion relating to any product pricing, methods or channels of product distribution, division of markets, allocation of customers or any other topic that should not be discussed among competitors. - -**Reminder - Meeting is recorded** - -## Roll Call - -Please add 'Attended' to this issue during the meeting to denote attendance. - -## Agenda - - [ ] **Convene & Roll Call** - - [ ] **Agree Agenda** - - [ ] **[Approve Previous Meeting Minutes](https://github.com/OvertureMaps/schema-wg/issues?q=is%3Aopen+is%3Aissue+label%3AAgenda%2FMinutes)** - -## Task Force (TF) Stand-up -**[Update status here](https://wiki.overturemaps.org/display/PROJ/Overture+H1+Technical+Deliverables+Tracking#OvertureH1TechnicalDeliverablesTracking-M3|APR-26(updatedApr-05))** -- [ ] Places TF -- [ ] Buildings TF -- [ ] Transportation TF -- [ ] Admin TF -- [ ] GERS TF - -## [PRs](https://github.com/OvertureMaps/schema-wg/pulls) - -## [Issue](https://github.com/OvertureMaps/schema-wg/issues) - - -## AOB - - [ ] Add - -## Next meeting -- [] dd mmm - -## Adjourn -- [ ] No objections? From fcb26576c9fa683ee148f7cea9b9c85fd409f480 Mon Sep 17 00:00:00 2001 From: Jennings Anderson Date: Wed, 5 Jul 2023 11:29:29 -0700 Subject: [PATCH 6/9] Adding the license text to the schema documentation --- docusaurus/docs/index.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docusaurus/docs/index.mdx b/docusaurus/docs/index.mdx index 29aa86fa..e0f98584 100644 --- a/docusaurus/docs/index.mdx +++ b/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). From d0725ffc17e4c72891f865bed8d51e6ab16f542b Mon Sep 17 00:00:00 2001 From: Jennings Anderson Date: Wed, 5 Jul 2023 11:50:16 -0700 Subject: [PATCH 7/9] updating readme --- docusaurus/README.md | 23 ++++++++--------------- 1 file changed, 8 insertions(+), 15 deletions(-) diff --git a/docusaurus/README.md b/docusaurus/README.md index 386058c8..3d6d2ca4 100644 --- a/docusaurus/README.md +++ b/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 ``` From d5d2faa72d9c111b5e1ac2f381986305d3430a54 Mon Sep 17 00:00:00 2001 From: Jennings Anderson Date: Wed, 5 Jul 2023 11:56:35 -0700 Subject: [PATCH 8/9] Create documentation_update.md --- .github/PULL_REQUEST_TEMPLATE/documentation_update.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/documentation_update.md diff --git a/.github/PULL_REQUEST_TEMPLATE/documentation_update.md b/.github/PULL_REQUEST_TEMPLATE/documentation_update.md new file mode 100644 index 00000000..a10a85ca --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/documentation_update.md @@ -0,0 +1,3 @@ +# Update to the Schema Documentation Website + +To view this PR, check out: From b15c1ceca4271c605c5757dc2ccca5a7b61479b8 Mon Sep 17 00:00:00 2001 From: Jennings Anderson Date: Wed, 5 Jul 2023 11:59:27 -0700 Subject: [PATCH 9/9] Update documentation_update.md --- .github/PULL_REQUEST_TEMPLATE/documentation_update.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/documentation_update.md b/.github/PULL_REQUEST_TEMPLATE/documentation_update.md index a10a85ca..c6d981af 100644 --- a/.github/PULL_REQUEST_TEMPLATE/documentation_update.md +++ b/.github/PULL_REQUEST_TEMPLATE/documentation_update.md @@ -1,3 +1,4 @@ # Update to the Schema Documentation Website -To view this PR, check out: +To view the changes this PR introduces to the documentation website, view the [https://dfhx9f55j8eg5.cloudfront.net/pr/](Page Preview) +