From 88ffb3efb3914c1eab7f300b2d75804ac48f2cf8 Mon Sep 17 00:00:00 2001 From: Jennings Anderson Date: Wed, 17 Jul 2024 16:39:03 -0700 Subject: [PATCH] Updating staging from `dev` for documentation (#251) * update language around subtypes for the divisions theme documentation (#248) * update language around subtypes for the divisions theme * add dependency to the list of available subtypes * [documentation] Address scaffolding for schema pages (#233) * address scaffolding for schema pages * Initial schema docs description * Update address.mdx --------- Co-authored-by: Jacob Wasserman --------- Co-authored-by: Dana Bauer Co-authored-by: Jacob Wasserman --- .../concepts/by-theme/addresses/index.mdx | 23 +++++++ .../schema/reference/addresses/address.mdx | 69 +++++++++++++++++++ .../schema/reference/divisions/division.mdx | 35 +++++++++- .../reference/divisions/division_area.mdx | 24 ++++++- .../reference/divisions/division_boundary.mdx | 58 +++++++++++++++- 5 files changed, 204 insertions(+), 5 deletions(-) create mode 100644 docusaurus/docs/schema/concepts/by-theme/addresses/index.mdx create mode 100644 docusaurus/docs/schema/reference/addresses/address.mdx diff --git a/docusaurus/docs/schema/concepts/by-theme/addresses/index.mdx b/docusaurus/docs/schema/concepts/by-theme/addresses/index.mdx new file mode 100644 index 00000000..30ac0b4d --- /dev/null +++ b/docusaurus/docs/schema/concepts/by-theme/addresses/index.mdx @@ -0,0 +1,23 @@ +--- +title: Addresses +draft: true +--- + +## Overview +The Overture Address theme is a compilation of open address datasets usually +published by local authorized sources. In our initial release, we use the datasets +that are collected and distributed by [OpenAdddresses](https://openaddresses.io). + +The initial schema for addresses is fairly simple and is expected to expand into +more complex addressing schemes. + + + +## Feature types +The address theme has a single feature type. +- `address` is a point feature type representing a single address point. + +## Theme concepts + +## Schema reference +- [Explore the schema for the address feature type](/schema/reference/Addresses/address) diff --git a/docusaurus/docs/schema/reference/addresses/address.mdx b/docusaurus/docs/schema/reference/addresses/address.mdx new file mode 100644 index 00000000..692182c7 --- /dev/null +++ b/docusaurus/docs/schema/reference/addresses/address.mdx @@ -0,0 +1,69 @@ +--- +title: address +--- + +import CodeBlock from '@theme/CodeBlock'; +import JSONSchemaViewer from "@theme/JSONSchemaViewer"; +import generateResolverOptions from "@site/src/components/shared-libs/generateResolverOptions" +import yamlLoad from "@site/src/components/yamlLoad" +import AddressSchema from "!!raw-loader!@site/docs/_schema/addresses/address.yaml"; + +import AddressExample from "!!raw-loader!@site/docs/_examples/addresses/address.yaml"; + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Address + +The Overture Address type is a compilation of open address datasets usually +published by local authorized sources. In our initial release, we use the datasets +that are collected and distributed by [OpenAdddresses](https://openaddresses.io). + +The initial schema for addresses is fairly simple and is expected to expand into +more complex addressing schemes. + +## Feature types +The address theme has a single feature type. +- `address` is a point feature type representing a single address point. + +## Theme concepts + + + + + + + + + + + + + + + + + +
Geometry Type + Point +
Themeaddresses
Typeaddress
+ + +## Schema + + + + + + + {AddressSchema} + + + +## Examples + + + + { JSON.stringify(yamlLoad(AddressExample), null, 2) } + + diff --git a/docusaurus/docs/schema/reference/divisions/division.mdx b/docusaurus/docs/schema/reference/divisions/division.mdx index 57d673d2..1ca167d7 100644 --- a/docusaurus/docs/schema/reference/divisions/division.mdx +++ b/docusaurus/docs/schema/reference/divisions/division.mdx @@ -40,14 +40,18 @@ A division is a recognized official or non-official organization of people as se ## Subtypes -A division may include one of the following subtypes: +While the schema for the divisions theme contains an comprehensive list of subtypes, only a subset are available in the data today. + +Currently, the following subtypes are available in the `division` feature type: - `country` +- `dependency` - `region` - `county` - `localadmin` - `locality` - `neighborhood` +- `microhood` @@ -64,6 +68,21 @@ A division may include one of the following subtypes: A country is the largest unit of independent sovereignty. The border of a country, if known, is given by [division boundary](/schema/reference/divisions/division_boundary) features. Example: United States + + + + + + + + +
subtypedependency
+ + + A dependency is a place that is not exactly a sub-region of a country but is dependent on a parent country for defense, passport control, etc. Example: Puerto Rico + + + @@ -133,6 +152,20 @@ A locality is a populated place that may or may not have its own administrative A neighborhood is a geographically localized community within a city, town, suburb or rural area, sometimes consisting of a single street and the buildings lining it. Example: Cobble Hill + + +
+ + + + + + +
subtypemicrohood
+ + +A microhood is a mini-neighborhood that is contained within a neighborhood. Example: Gätjensort in Hamburg + diff --git a/docusaurus/docs/schema/reference/divisions/division_area.mdx b/docusaurus/docs/schema/reference/divisions/division_area.mdx index 0658e58e..d4c0035b 100644 --- a/docusaurus/docs/schema/reference/divisions/division_area.mdx +++ b/docusaurus/docs/schema/reference/divisions/division_area.mdx @@ -14,7 +14,7 @@ import division_area_example_region_land from '!!raw-loader!@site/docs/_examples import division_area_example_country_maritime from '!!raw-loader!@site/docs/_examples/divisions/division_area/country_maritime.yaml'; -# Division Area +# Division area A division area is a polygon that represents the land or maritime area associated with a [division](/schema/reference/divisions/division). @@ -38,13 +38,16 @@ A division area is a polygon that represents the land or maritime area associate ## Subtypes -Like a division, a division area may have one of following subtypes: +While the schema for the divisions theme contains an comprehensive list of subtypes, only a subset are available in the data today. + +Currently, the following subtypes are available in the `division_area` feature type: - `country` +- `dependency` - `region` - `county` -- `locality` - `localadmin` +- `locality` - `neighborhood` @@ -63,6 +66,21 @@ A country is the largest unit of independent sovereignty. The border of a countr + + + + + + + + +
subtypedependency
+ + + A dependency is a place that is not exactly a sub-region of a country but is dependent on a parent country for defense, passport control, etc. Example: Puerto Rico + + + diff --git a/docusaurus/docs/schema/reference/divisions/division_boundary.mdx b/docusaurus/docs/schema/reference/divisions/division_boundary.mdx index c840f69f..c28788d7 100644 --- a/docusaurus/docs/schema/reference/divisions/division_boundary.mdx +++ b/docusaurus/docs/schema/reference/divisions/division_boundary.mdx @@ -13,7 +13,7 @@ import divisions_disputed_boundary_example_both from '!!raw-loader!@site/docs/_e import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# Division Boundary +# Division boundary A division boundary is a border between [divisions](/schema/reference/divisions/division). @@ -41,6 +41,62 @@ geopolitical issues, some boundaries represent standalone disputed or treaty lines and therefore do not coincide with the border of a division. +## Subtypes + +While the schema for the divisions theme contains an comprehensive list of subtypes, only a subset are available in the data today. + +Currently, the following subtypes are available in the `division_boundary` feature type: + +- `country` +- `region` +- `county` + + + +
+ + + + + + +
subtypecountry
+ + +A country is the largest unit of independent sovereignty. The border of a country, if known, is given by [divsion boundary](/schema/reference/divisions/division_boundary) features. Example: United States + + + + + + + + + + + +
subtyperegion
+ +A region is the largest administrative unit within most countries and a first-level administrative subdivision. Example: Alberta + + + + + + + + + + +
subtypecounty
+ + +A county is a second-level administrative subdivision. Example: Kings County, NY + + + + + ## Schema