Skip to content

Update Search docs to recommend Federated Search followed by source STAC item search #584

Description

@hrodmn

Goal

Update the Search section of the MAAP documentation site to reflect the new recommended data discovery workflow:

  1. Use Federated Search to discover relevant collections across catalogs.
  2. Identify the collection's source STAC API from the result.
  3. Perform item-level search in that source STAC API.

Problem

The current Search docs still center the user journey around choosing between NASA CMR and MAAP STAC up front. That is now the wrong default workflow.

Today:

  • docs/source/technical_tutorials/searching.rst tells users to use "two catalogs"
  • docs/source/technical_tutorials/search/catalog.rst is framed as "MAAP's Dual Catalog"
  • several notebooks still read like primary entry points for CMR-specific search

The docs structure and navigation still teach the old search workflow.

Scope

  • Rewrite the Search landing page around the new workflow
  • Replace "dual catalog" framing with workflow-oriented guidance
  • Promote the Federated Search notebook as the canonical starting point
  • Reframe STAC item-search content as the next step after collection discovery
  • Demote or clearly scope CMR- and Earthdata-specific notebooks as specialized or legacy paths
  • Add cross-links so users can move cleanly from collection discovery to item search

Non-goals

  • Rewriting all search tutorials from scratch
  • Changing the behavior of the Federated Search tool itself
  • Removing NASA CMR or Earthdata-specific documentation entirely
  • Updating unrelated access or visualization tutorials beyond necessary cross-links

Proposed changes

1. Search landing page

  • Update docs/source/technical_tutorials/searching.rst
  • Replace the "two catalogs" intro with a recommended workflow section
  • Reorder the Search toctree so Federated Search appears first
  • Position the rest of the tutorials as follow-on paths rather than alternative starting points

2. Catalog background page

  • Update docs/source/technical_tutorials/search/catalog.rst
  • Replace "MAAP's Dual Catalog" framing with a workflow-oriented page
  • Explain why users should start with Federated Search
  • Add guidance for what to do after discovery: inspect the upstream/source STAC API and continue item-level search there
  • Preserve MAAP CMR deprecation and migration notes, but move them out of the lead narrative

3. Federated Search notebook

  • Update docs/source/technical_tutorials/search/federated-collection-discovery/collection_discovery.ipynb
  • Make this the canonical starting point for finding collections
  • Emphasize that this tutorial is for collection discovery, not item search
  • Add a closing section describing the next step once a collection is found:
    • MAAP STAC result -> search items in MAAP STAC
    • NASA CMR STAC result -> search items in NASA CMR STAC
    • ESA MAAP STAC result -> search items in ESA MAAP STAC

4. Generic STAC item-search tutorial

  • Update docs/source/technical_tutorials/search/searching_the_stac_catalog.ipynb
  • Reframe it as the generic item-level STAC search pattern used after collection discovery
  • Make the STAC API URL and collection ID clearly user-replaceable based on Federated Search results
  • Keep MAAP STAC as an example if helpful, but not as the only implied target

5. CMR- and Earthdata-specific notebooks

  • Update:
    • docs/source/technical_tutorials/search/collections.ipynb
    • docs/source/technical_tutorials/search/granules.ipynb
    • docs/source/technical_tutorials/search/searching_edsc_gui.ipynb
  • Add top-of-notebook notes that these are not the recommended starting point for general collection discovery
  • Reframe them as NASA-specific or specialized workflows for users who already know they need CMR or Earthdata Search
  • Link back to the Federated Search tutorial

6. Applied example consistency

  • Update docs/source/technical_tutorials/search/searching_NISAR_BIOMASS_overlapping_data.ipynb
  • Add a short note that the notebook assumes the user already knows the collection IDs and source STAC APIs
  • Point users to Federated Search as a way to obtain those inputs

7. R tutorial consistency

  • Review and update as needed:
    • docs/source/technical_tutorials/working_with_r/cmr_search_in_r.ipynb
    • docs/source/technical_tutorials/working_with_r/access_cmr_r.ipynb
    • docs/source/technical_tutorials/working_with_r/maap_stac_r.ipynb
  • Ensure they align with the same story:
    • Federated Search for collection discovery
    • STAC item search in the API where the collection lives
    • CMR-specific material clearly labeled when applicable

Acceptance criteria

  • docs/source/technical_tutorials/searching.rst presents Federated Search as the recommended first step
  • docs/source/technical_tutorials/search/catalog.rst no longer centers the section around a "dual catalog" choice
  • The Search section navigation reflects the new workflow order
  • The Federated Search notebook is clearly positioned as the canonical collection-discovery entry point
  • The STAC search notebook is clearly positioned as the generic item-level follow-on tutorial
  • CMR- and Earthdata-specific notebooks include clear scope notes and links back to Federated Search
  • Relevant R notebooks are consistent with the new workflow
  • Cross-links between discovery and follow-on item-search tutorials are in place

Validation

  • Build the docs successfully
  • Review the rendered Search section navigation and page intros for workflow consistency
  • Verify that a new user can follow the docs from collection discovery to item search without being asked to choose CMR vs MAAP STAC up front

Implementation notes

Suggested Search section order:

  1. search/federated-collection-discovery/collection_discovery.ipynb
  2. search/searching_the_stac_catalog.ipynb
  3. search/catalog.rst
  4. search/collections.ipynb
  5. search/granules.ipynb
  6. search/searching_edsc_gui.ipynb
  7. working_with_r/find_data_in_r.rst
  8. search/searching_NISAR_BIOMASS_overlapping_data.ipynb

Suggested terminology:

  • Use "collection discovery" for Federated Search
  • Use "item-level search" for STAC API follow-on searches
  • Prefer "source STAC API" or "upstream STAC API"
  • Avoid presenting "CMR vs MAAP STAC" as the primary decision point

Open questions

  • Should the CMR-specific Python notebooks remain as specialized alternatives, or should they eventually be rewritten around CMR STAC to better match the new STAC-first recommendation?
  • Do we want to rename searching_the_stac_catalog.ipynb in a follow-up for clearer workflow signaling, or just update its rendered title and intro for now?

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions