Skip to main content

Documentation can be added to developer portal by providing links to where the (Earthdata Developer Portal supported) documentation is hosted and accessible. Please send a request to Earthdata Support team with this information.

Updating your documentation

We reingest documentation weekly with our Thursday deployments. If you have updated your documentation and would like it reingested earlier than Thursday, send us a note at Earthdata Support.

Document types supported

Earthdata developer portal supports the following documentation source types specified in a YAML format.

Markdown

Markdown documents require Git repo URL and (if not default) optional branch in the repo that hosts the documents along with username and password to access the repo. Each document within the repo that needs to be included in EDP must be specified with source URL within the repo and the target path within EDP where it should reside. It can optionally take a title to replace the one in the repo for that page and whether the page is restricted content. Markdown documents with Commonmark flavor are supported.

Example:

- type: Markdown
  config:
    repo_url: 'https://git.earthdata.nasa.gov/scm/cmr/cmr.git'
      username: 'username'
      password: 'password'
    pages:
    - target_path: 'cmr/changelog'
      source_path: 'CHANGELOG.md'
    - target_path: 'cmr/api/docs'
      source_path: 'search-app/api_docs.md'
    - title: 'Metadata Ingest API Overview'
      restricted: true 
      target_path: 'cmr/api/ingest'
      source_path: 'ingest-app/api_docs.md'
    - title: 'Access Control API Overview'
      target_path: 'cmr/api/access'
      source_path: 'access-control-app/api_docs.md'

Confluence

Confluence documents require URL for the Confluence site, and username and password with access to the pages. Each page that is to be ingested needs to specify the id within Confluence and it's path within EDP where it will be hosted. It optionally takes upload_children parameter (values true or false) to ingest child Confluence pages. Not all Confluence macros are currently supported. Please contact development team if unsupported macros are used in pages that need to be ingested. Currently supported Confluence macros: * Attachments * Accordions * ContentByLabel * UI TextBox

Example:

- type: Confluence
  config:
    username: 'username'
    password: 'password'
    base_url: 'https://wiki.earthdata.nasa.gov/'
    pages:
      - id: 33589405 # https://wiki.earthdata.nasa.gov/display/URSFOUR/What+Do+I+Need+to+Know+About+URS
        path: 'urs/overview'
      - id: 35848716
        path: 'urs/knowledge-base'
        upload_children: true
        restricted: true
      - id: 35848228
        path: 'urs/urs-integration'
        upload_children: true
      - id: 38995693 # https://wiki.earthdata.nasa.gov/display/URSFOUR/How+To+Add+a+Custom+Image+to+An+Application
        path: 'urs/add-custom-image'
Html

Each html page needs to specify the URL of the page and a CSS selector within the page from which to extract the content and the path within EDP. It optionaly takes a title of the page to provide a new or replace an existing page title. Title is extracted from the page by looking for the highest level {H1 .. H6} element within the content.

Example:

- type: Html
  config:
    src_url: 'https://cmr.earthdata.nasa.gov/csw/collections'
    content_selector: 'section.content'
    path: 'cmr/csw/collections'
Conduit

Conduit pages can be ingested by retrieving them from the API URL for a specified Conduit project and username and password with access to the Conduit project. All published pages (and unpublished pages if include_drafts option is set to true (defaults to false) will be ingested. Example:

- type: Conduit
  config:
    api_url: 'https://conduit.earthdata.nasa.gov/api/v1'
    api_project: 'PROJ1'
    api_username: 'username'
    api_password: 'password'
    include_drafts: true
Swagger

A single swagger page can be created to reference multiple swagger URLs. It requires a title, path within EDP and set of swagger URLs. Example:

- type: Swagger
  config:
    title: 'CMR API Reference'
    path: 'cmr/api'
    restricted: true
    swagger_urls:
      - api_name: 'Prod'
        api_path: 'https://cmr.earthdata.nasa.gov/search/site/swagger.json'
      - api_name: 'UAT'
        api_path: 'https://cmr.uat.earthdata.nasa.gov/search/site/swagger.json'
Json

Json page needs to specify page URL, username, password (if it needs authentication), page title, and path within EDP. It optionally can specify whether to use SSL (defaults to true). Example:

- type: Json
  config:
    api_password: 'password'
    api_url: 'https://git.earthdata.nasa.gov/projects/EMFD/repos/unified-metadata-model/browse/v1.3/umm-c-json-schema.json'
    api_username: 'username'
    title: 'CMR C-Schema'
    path:  'cmr/umm/umm-c-json-schema'
    api_project: 'CMR'
    verify_ssl: false
Xml Schema

Xml Schema pages can be ingested from a specific URL. It takes values for page title, and path within EDP.

Example:

- type: Xsd
  config:
    url: 'https://cdn.earthdata.nasa.gov/dif/9.x/dif_v9.9.3.xsd'
    title: 'Directory Interchange Format 9'
    path:  'cmr/schemas/dif9'

Restricted pages

All the adapters (except Conduit adapter) optionally can specify whether the page is restricted (defaults is false) Restricted pages will only be available to view to authenticated users. Unauthenticated users will have access to links to restricted pages in menu or other pages but will not be able to see the content of the restricted pages.

Example:

- type: Xsd
  config:
    url: 'https://cdn.earthdata.nasa.gov/dif/9.x/dif_v9.9.3.xsd'
    title: 'Directory Interchange Format 9'
    path:  'cmr/schemas/dif9'
    restricted: true
- name: CMR Wiki Docs
  type: Confluence
  config:
    username: 'username'
    password: 'password'
    base_url: 'https://wiki.earthdata.nasa.gov/'
    pages:
      - id: 75827714 # https://wiki.earthdata.nasa.gov/display/CMR/Getting+Started+with+the+CMR
        path: 'getting-started/search-and-get-earth-science-data'
        restricted: true
      - id: 75827707 # https://wiki.earthdata.nasa.gov/pages/viewpage.action?pageId=75827707
        path: 'cmr/overview'
- type: Swagger
  config:
    title: 'CMR API Reference'
    path: 'cmr/api'
    restricted: true
    swagger_urls:
      - api_name: 'Prod'
        api_path: 'https://cmr.earthdata.nasa.gov/search/site/swagger.json'
      - api_name: 'UAT'
        api_path: 'https://cmr.uat.earthdata.nasa.gov/search/site/swagger.json'
      - api_name: 'SIT'
        api_path: 'https://cmr.sit.earthdata.nasa.gov/search/site/swagger.json'