Skip to content

docs: data-publishing user guide + configuration - #178

Merged
Anthony Cintron (prbatero) merged 3 commits into
mainfrom
prbatero/docs/data-publishing
Sep 1, 2026
Merged

docs: data-publishing user guide + configuration#178
Anthony Cintron (prbatero) merged 3 commits into
mainfrom
prbatero/docs/data-publishing

Conversation

@prbatero

Copy link
Copy Markdown
Contributor

Adds documentation for the data-publishing feature to the docs site (docs/), consistent with the existing User Guide style.

What's added

  • New page `usage/data-publishing.md** — inserted in the User Guide between Damage Mapping and Building Blocks. Covers:
    • Choosing a target (Local vs Planetary Computer) with a comparison table
    • Publishing from a model's Results menu (the dialog fields)
    • Managing Published Datasets — statuses, edit metadata, retry, unpublish, and the force-remove escape hatch (with the orphaned-resource warning)
    • Source-imagery attribution — providers/derived_from/citation, and the licensing safeguard (only registered open-data imagery is attributed; source pixels are never published)
    • Viewing in the PC Explorer — the damage-classification render layer
    • Enabling and configuring — in-app env settings + out-of-app GeoCatalog setup, linking the official Planetary Computer Pro docs
  • Configuration guide — a new Data publishing section with the full HASTE_* env matrix (feature flags, PC target, publish storage + attribution) and a Contents entry
  • Deployment guide — a PC-publishing prerequisites note (external GeoCatalog + the two RBAC role grants)
  • Cross-links from the User Guide overview and both workflow Results sections

Validation

Builds locally with jupyter-book build docs/build succeeds, no new warnings on any changed page.

⚠️ Merge order

The Viewing in the Planetary Computer Explorer section and the HASTE_PUBLISH_EXPLORER_RENDER_ENABLED row document the Explorer visualization that is still in-flight in #175. Merge this docs PR after #175 so the site matches main.

Add a comprehensive user guide for the data-publishing feature under the
User Guide (usage/data-publishing, between damage-mapping and
building-blocks): choosing a target (Local vs Planetary Computer),
publishing from Results, managing published datasets (statuses, edit,
retry, unpublish, force-remove), source-imagery attribution, viewing in
the PC Explorer, and enabling/configuring the feature (in-app env +
out-of-app GeoCatalog setup with links to the official MPC Pro docs).

Also: a Data publishing section in the configuration guide (full HASTE_*
env matrix), a PC prerequisites note in the deployment guide, and
cross-links from the overview and both workflow Results sections.

Builds clean with jupyter-book (no new warnings).
@prbatero
Anthony Cintron (prbatero) requested a review from a team as a code owner August 29, 2026 17:08
Wire the 7 captures into usage/data-publishing.md: the target dropdown,
the Publish dataset menu item and dialog, the Published Datasets list
(with the row action menu) and detail view, the edit-metadata form, and
the damage-classification layer in the Planetary Computer Explorer.
Refine the publish steps to match the dialog's actual labels/order
(Assets to publish, Target publishing location). Explorer capture
downscaled to 1920px to match the repo's image budget.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds user, configuration, and deployment documentation for data publishing, including Planetary Computer integration pending PR #175.

Changes:

  • Adds the Publishing Datasets user guide.
  • Documents publishing configuration and deployment prerequisites.
  • Adds navigation and workflow cross-links.

Reviewed changes

Copilot reviewed 7 out of 14 changed files in this pull request and generated 8 comments.

Show a summary per file
File Description
docs/usage/data-publishing.md Adds the publishing user guide.
docs/configuration.md Documents publishing settings.
docs/deployment.md Adds deployment prerequisites.
docs/_toc.yml Registers the new guide.
docs/usage/overview.md Links publishing from the overview.
docs/usage/damage-mapping.md Links publishing from results.
docs/usage/rapid-building-assessment.md Links publishing from assessments.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/usage/data-publishing.md
Comment thread docs/usage/data-publishing.md
Comment thread docs/usage/data-publishing.md Outdated
Comment thread docs/usage/data-publishing.md Outdated
Comment thread docs/deployment.md Outdated
Comment thread docs/configuration.md Outdated
Comment thread docs/usage/data-publishing.md Outdated
Comment thread docs/usage/data-publishing.md Outdated
- data-publishing: add a Contents list (repo doc guideline); note the
  valid-area mask must stay selected for Planetary Computer (a publish
  without it is rejected); clarify Published Datasets is tenant-wide (all
  authenticated users see every published dataset), and that View details
  is available to everyone while edit/retry/unpublish/force-remove are
  owner/admin only; scope the 'never publishes source pixels' claim to the
  PC target and note Local can archive the processed image within HASTE;
  add the missing GeoCatalog data-plane RBAC grant to the setup and fix the
  'both grants' wording to three.
- deployment: list the GeoCatalog data-plane grant alongside the two
  storage grants.
- configuration: document that PUBLISH_STORAGE_ACCOUNT_URL and
  PUBLISH_BLOB_CONTAINER are an all-or-nothing pair (either empty falls
  back to in-place primary storage, which a firewalled GeoCatalog can't
  ingest).
- _config: enable myst_heading_anchors so the Contents links resolve
  (also clears the pre-existing configuration.md TOC warnings).

Builds clean with jupyter-book (no new warnings).
@prbatero Anthony Cintron (prbatero) linked an issue Aug 31, 2026 that may be closed by this pull request
1 task

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@prbatero
Anthony Cintron (prbatero) merged commit 75d1c93 into main Sep 1, 2026
10 checks passed
@prbatero
Anthony Cintron (prbatero) deleted the prbatero/docs/data-publishing branch September 1, 2026 12:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature]: Data Publishing & Published Datasets

3 participants