Versions Compared

Old Version 17

changes.mady.by.user Trevor Lang

Saved on

compared with

New Version 18

changes.mady.by.user user-c2913

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The remainder of this document will walk through the process of creating and configuring a portal.

Table of Contents
maxLevel3

Step 1: Reach out!

We're here to help, and we want to understand community needs so we can refine our features. Email Chris Lynnes (christopher.s.lynnes@nasa.gov) to get started with your portal and get in touch with developers.

...

KeyData TypeExplanation
hasStyles
Boolean

This tells EDSC if it needs to load a "styles.scss" file,  see Advanced Configuration.

hasScripts
BooleanThis tells EDSC if it needs to load a "scripts.js" file, see Advanced Configuration.
hideCollectionFilters
BooleanIf true, EDSC will hide the checkboxes " and
logo
Object (Optional)Configuration for a logo to appear to the right of the NASA logo in the upper left of the page. If omitted, no logo will be added.
    id
String (Optional)This is the id attribute of the <a> tag that houses the logo image, see Advanced Configuration.
    image
String (Optional)Path to logo image. This is not recommended, please see Advanced Configuration for the preferred method of adding the logo image.
    link
String (Optional)This is the URL that users will be sent to when clicking on the logo image. If no value is provided clicking on the logo image will return the user to the EDSC portal home (/portal/example/search).
    title
String (Optional)This text is set as the title attribute in the <a> tag that houses the logo image, it will be displayed when you user hovers their mouse over the logo
org
String (Optional)A short string representing the organization that replaces "Earthdata" in the top-left of the site toolbar. If omitted, it will just say "Earthdata."
query
Object (Optional)

These parameters are used to filter the list of collections available in the portal. 

Current supported values:

  • tagKey
  • dataCenter
  • project
  • hasGranulesOrCwic (set to null to include all collections)
  • echoCollectionId (this narrows the results to a single collection, only used as an example)

If you need support of another CMR query parameter, please contact us.

Refer to the CMR documentation for information on parameters:
https://cmr.earthdata.nasa.gov/search/site/search_api_docs.html 

title
String (Optional)A short string to be used when referring to the portal. This will appear verbatim where the word "Search" is in the top-left of the site toolbar and will appear in various other places as "Example Portal" when referring to the portal. If omitted, a capitalized version of the portal ID will be used, i.e. "Example."

Advanced Configuration

Portals allow authors to provide SASS styles and JavaScript to run on each page within the portal. These can be useful for altering the page style, hiding unnecessary features, or adding new features that do not make sense for inclusion in Earthdata Search. You can do essentially anything that can be done with Javascript or SASS.

...