Skip to content
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
11 changes: 6 additions & 5 deletions .github/workflows/staging_deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:
- name: Staging deploy is not supported for fork PRs
if: github.event.pull_request.head.repo.full_name != github.repository
run: |
echo "::warning title=Staging deploy not supported for fork PRs::Staging previews are only available for PRs from branches within this repository, not forks. Please open your PR from a branch in OvertureMaps/docs instead."
echo "::warning title=Staging deploy not supported for fork PRs::Staging previews are only available for PRs from branches within this repository, not forks. Please open your PR from a branch in OvertureMaps/docs."

build-auto-gen:
name: Build (auto-gen schema)
Expand Down Expand Up @@ -60,7 +60,7 @@ jobs:
uses: OvertureMaps/workflows/.github/actions/generate-schema-docs@faa3fa4bbe01d85dc2e2139ff1f74ce70feb7df9 # zizmor: ignore[stale-action-refs] - main
with:
output-dir: ${{ github.workspace }}/docs/schema/reference
schema-ref: 'dev' # Temporary until we feel confident in the generated schema sans human review, then should be 'main'
schema-ref: 'main'

- name: Build Docusaurus website
run: npm run build
Expand Down Expand Up @@ -171,13 +171,14 @@ jobs:
| | |
|-------------------------|----------------------------------------------------------------------|
| 🆕 **Auto-gen schema site (beta)** | ${{ env.STAGING_URL }}${{ env.PREVIEW_PATH }}/index.html |
| 🗂️ **Auto-gen schema ref** | [${{ steps.deploy-metadata.outputs.schema-ref-short }}@${{ steps.deploy-metadata.outputs.schema-short-sha }}](https://github.com/OvertureMaps/schema/commit/${{ needs.build-auto-gen.outputs.schema-sha }}) |
| 🗂️ **Auto-gen schema ref** | [${{ steps.deploy-metadata.outputs.schema-ref-short }}@${{ steps.deploy-metadata.outputs.schema-short-sha }}](https://github.com/OvertureMaps/schema/tree/${{ needs.build-auto-gen.outputs.schema-ref }}) |
| 🌍 **Repo schema site** | ${{ env.STAGING_URL }}${{ env.PREVIEW_PATH_NO_AUTOGEN }}/index.html |
| 🕐 **Updated** | ${{ steps.deploy-metadata.outputs.time }} |
| 📝 **Commit** | [${{ steps.deploy-metadata.outputs.short-sha }}](${{ github.server_url }}/${{ github.repository }}/commit/${{ github.event.pull_request.head.sha }}) |

Auto-gen schema site is now available. This is an early preview of a future workflow where we will automatically generate and publish reference docs for the Overture Maps Format schema with every change to the schema repo.
The auto-gen schema site may contain incomplete or inaccurate information as we are still refining the generation process, so please compare against the repo schema site and refer to the linked commit for the most up-to-date source of truth.
Auto-gen schema site is now available. This is an early preview of a future workflow where we will automatically generate and publish reference docs for the Overture Maps Format schema.

The auto-gen schema site may contain incomplete or inaccurate information as we are still refining the generation process, so please compare against the repo schema site and refer to the official Overture documentation for authoritative information.

> [!NOTE]
> ♻️ This preview updates automatically with each push to this PR.
69 changes: 45 additions & 24 deletions docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,31 +6,52 @@ hide_table_of_contents: true
className: landing-page
---

import {
Hero,
HeroHeadline,
HeroSubtext,
HeroCTAs,
PrimaryButton,
SecondaryButton,
ExplorerEmbed,
} from '@site/src/components/home';
import { LandingTitle, FeaturedLink, DocSection, DocLink } from '@site/src/components/home';

<Hero>
<HeroHeadline />
<LandingTitle>Overture Documentation</LandingTitle>

<HeroSubtext>
A platform for bringing together tech companies, mapping organizations, government agencies, open
data communities, and researchers to build open, reliable, and interoperable map data
infrastructure.
</HeroSubtext>
<FeaturedLink to="/getting-data/" title="Quickstart" icon="⚡︎">
The fastest ways to get started. Browse features in [Overture Explorer](https://explore.overturemaps.org), download data with the [Overture Python CLI](/getting-data/overturemaps-py/), query with [DuckDB](/getting-data/duckdb/), or pull Overture data into [ArcGIS](https://livingatlas.arcgis.com/en/home/) and [QGIS](/examples/QGIS/).
</FeaturedLink>

<HeroCTAs>
<PrimaryButton to="/getting-data/">Quickstart</PrimaryButton>
<SecondaryButton href="https://explore.overturemaps.org">
Explore the data and schema →
</SecondaryButton>
</HeroCTAs>
</Hero>
<DocSection title="Where to get the data">
<DocLink to="/getting-data/cloud-sources/" title="Official Overture sources">
Direct access to Overture releases on Amazon S3 and Microsoft Azure.
</DocLink>
<DocLink to="/getting-data/data-mirrors/" title="Data mirrors">
Overture data hosted by partners: BigQuery, Databricks, Fused, Snowflake, and Wherobots.
</DocLink>
<DocLink href="https://livingatlas.arcgis.com/en/home/" title="ArcGIS" hideArrow>
Find Overture data in the Esri ArcGIS Living Atlas.
</DocLink>
<DocLink to="/release-calendar/" title="Release calendar">
Upcoming Overture data releases and what's included in each one.
</DocLink>
</DocSection>

<ExplorerEmbed />
<DocSection title="Reference">
<DocLink to="/schema/" title="Schema reference">
Full schema reference for Overture datasets.
</DocLink>
<DocLink to="/gers/" title="Global Entity Reference System">
Stable identifiers (GERS IDs) that let you join Overture data to your own datasets and track features over time.
</DocLink>
</DocSection>

<DocSection title="Guides and Examples">
<DocLink to="/guides/" title="Guides">
Theme-by-theme guides for addresses, base, buildings, divisions, places, and transportation.
</DocLink>
<DocLink to="/examples/" title="Examples">
End-to-end walkthroughs using DuckDB, Athena, QGIS, CARTO, Fused, Sedona, Spark, and more.
</DocLink>
<DocLink to="/attribution/" title="Attribution and Licensing">
How to cite Overture data and meet attribution requirements for upstream sources.
</DocLink>
</DocSection>

<DocSection title="Support">
<DocLink to="/support/" title="Support">
GitHub Discussions, issue trackers, and other ways to get help.
</DocLink>
</DocSection>
81 changes: 0 additions & 81 deletions src/components/RotatingWord.jsx

This file was deleted.

49 changes: 0 additions & 49 deletions src/components/RotatingWord.module.css

This file was deleted.

87 changes: 33 additions & 54 deletions src/components/home.jsx
Original file line number Diff line number Diff line change
@@ -1,71 +1,50 @@
import Link from '@docusaurus/Link';
import RotatingWord from './RotatingWord';
import styles from './home.module.css';

export function Hero({ children }) {
return <section className={styles.hero}>{children}</section>;
export function LandingTitle({ children }) {
return <h1 className={styles.introTitle}>{children}</h1>;
}

export function HeroHeadline() {
export function FeaturedLink({ to, href, title, icon, children }) {
const isExternal = !!href;
const linkProps = isExternal
? { href, target: '_blank', rel: 'noopener noreferrer' }
: { to };
const Component = isExternal ? 'a' : Link;
return (
<div className={styles.headline}>
<div className={styles.headlineTop}>
<span className={styles.headlineStatic}>Overture</span>
<span className={styles.headlineIs}>is</span>
</div>
<RotatingWord />
<div className={styles.featured}>
<Component className={styles.featuredTitle} {...linkProps}>
{icon && <span className={styles.featuredIcon} aria-hidden="true">{icon}</span>}
{title}
{isExternal && <span className={styles.docLinkExternal}>{'↗'}</span>}
</Component>
<div className={styles.featuredDesc}>{children}</div>
</div>
);
}

export function HeroSubtext({ children }) {
return <div className={styles.subtext}>{children}</div>;
}

export function HeroCTAs({ children }) {
return <div className={styles.ctaRow}>{children}</div>;
}

export function PrimaryButton({ to, children }) {
export function DocSection({ title, children }) {
return (
<Link to={to} className={styles.btnPrimary}>
{children}
</Link>
<section className={styles.docSection}>
<h2 className={styles.docSectionTitle}>{title}</h2>
<ul className={styles.docLinks}>{children}</ul>
</section>
);
}

export function SecondaryButton({ href, children }) {
export function DocLink({ to, href, title, hideArrow, children }) {
const isExternal = !!href;
const linkProps = isExternal
? { href, target: '_blank', rel: 'noopener noreferrer' }
: { to };
const Component = isExternal ? 'a' : Link;
return (
<a
href={href}
className={styles.btnSecondary}
target="_blank"
rel="noopener noreferrer"
>
{children}
</a>
);
}

export function ExplorerEmbed({ src = 'https://explore.overturemaps.org' }) {
return (
<div className={styles.explorerSection}>
<div className={styles.explorerFrame}>
<iframe
src={src}
title="Overture Maps Explorer"
loading="lazy"
allow="fullscreen"
/>
<a
className={styles.explorerOpen}
href="https://explore.overturemaps.org"
target="_blank"
rel="noopener noreferrer"
>
Open full screen {'\u2197'}
</a>
</div>
</div>
<li className={styles.docLinkItem}>
<Component className={styles.docLinkTitle} {...linkProps}>
{title}
{isExternal && !hideArrow && <span className={styles.docLinkExternal}>{'↗'}</span>}
</Component>
<span className={styles.docLinkDesc}>{children}</span>
</li>
);
}
Loading
Loading