diff --git a/.gitignore b/.gitignore index 6a163a6..ad5b3d5 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ _build -.DS_Store \ No newline at end of file +.DS_Store +*.bak \ No newline at end of file diff --git a/.readthedocs.yaml b/.readthedocs.yaml index a6cce9e..6620a8d 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,19 +1,24 @@ +# Read the Docs configuration file for myst +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details +# This file was created automatically with `myst init --readthedocs` + +# Required version: 2 +# Set the OS, Python version, and Node.js version +# Note: Python is included for executing code in notebooks or using Jupyter Book build: os: ubuntu-22.04 tools: python: "3.12" - jobs: - pre_build: - # Generate the Sphinx configuration for this Jupyter Book so it builds. - - "jupyter-book config sphinx ./" - -python: - install: - - requirements: requirements.txt - -sphinx: - builder: html - configuration: _config.yml - fail_on_warning: true + nodejs: "22" + commands: + # Install mystmd + - npm install -g mystmd + # Build the site + - myst build --html + # Copy the output to Read the Docs expected location + - mkdir -p $READTHEDOCS_OUTPUT/html/ + - cp -r _build/html/. "$READTHEDOCS_OUTPUT/html" + # Clean up build artifacts + - rm -rf _build diff --git a/_config.yml b/_config.yml deleted file mode 100644 index 183e4ba..0000000 --- a/_config.yml +++ /dev/null @@ -1,58 +0,0 @@ -# Book settings -# Learn more at https://jupyterbook.org/customize/config.html - -title: EarthScope Cloud Documentation Center -author: EarthScope On-Ramp Project Group -logo: _static/cloud_logo_simple_small.png -copyright: "2024" # Should go in the footer - -parse: - myst_substitutions: - geolab_docs_url: https://docs.earthscope.org/projects/GeoLab/ - geolab_github_url: https://github.com/EarthScope/GeoLab - jupyterhub_url: https://geolab.earthscope.cloud/hub/ - website_url: https://www.earthscope.org/data/geolab/ - sdkbeta_docs_url: https://docs.earthscope.org/projects/SDK-beta/ - api_docs_url: https://docs.earthscope.org/projects/API/ - - -# Force re-execution of notebooks on each build. -# See https://jupyterbook.org/content/execute.html -execute: - # execute_notebooks: force - execute_notebooks: off - -# Define the name of the latex output file for PDF builds -latex: - latex_documents: - targetname: book.tex - -# Add a bibtex file so that we can create citations -# bibtex_bibfiles: -# - references.bib - -# Information about where the book exists on the web -repository: - url: https://github.com/EarthScope/CloudDocs - branch: master # Which branch of the repository should be used when creating links (optional) - -# Add GitHub buttons to your book -# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository -html: - use_issues_button: false - use_repository_button: true - -# Specify what to build -only_build_toc_files: true - -sphinx: - intersphinx_mapping: - api: - - "https://docs.earthscope.org/projects/API/" - - null - sdkb: - - "https://docs.earthscope.org/projects/SDK-beta/" - - null - geolab: - - "https://docs.earthscope.org/projects/GeoLab/" - - null diff --git a/_toc.yml b/_toc.yml deleted file mode 100644 index b73310d..0000000 --- a/_toc.yml +++ /dev/null @@ -1,20 +0,0 @@ -# Table of contents -# Learn more at https://jupyterbook.org/customize/toc.html - -format: jb-book -root: intro -parts: -- caption: Getting Started - chapters: - - file: content/user_account -- caption: EarthScope Cloud Resources - chapters: - - url: https://docs.earthscope.org/projects/GeoLab - title: GeoLab - - url: https://docs.earthscope.org/projects/API - title: EarthScope API - - url: https://docs.earthscope.org/projects/CLI - title: EarthScope CLI - - url: https://docs.earthscope.org/projects/SDK - title: EarthScope SDK - diff --git a/content/citation.md b/content/citation.md new file mode 100644 index 0000000..da35e95 --- /dev/null +++ b/content/citation.md @@ -0,0 +1,7 @@ +# How to Cite the NSF NGF + +If you utilized any of our services in conducting your research, please acknowledge us and our sponsors. This enables us to show the value and impact of the facility. + +Work supported by the NSF National Geophysical Facility should acknowledge NSF award 2435260. + +For more details, please visit earthscope.org/how-to-cite. \ No newline at end of file diff --git a/content/img/es_user_create.png b/content/img/es_user_create.png new file mode 100644 index 0000000..d3c2885 Binary files /dev/null and b/content/img/es_user_create.png differ diff --git a/content/user_account.md b/content/user_account.md index 895e0c5..babce27 100644 --- a/content/user_account.md +++ b/content/user_account.md @@ -1,7 +1,20 @@ -# User Account Creation +# EarthScope User Accounts Welcome to EarthScope Cloud! -To access most of our data and cloud tools, you will need to register for a FREE user account. +To access most of our data and cloud tools, you will need a FREE user account. +Log in at https://earthscope.org/user -Visit our [EarthScope User Management account page](https://www.earthscope.org/data/authentication/) to sign up and/or view your existing user profile. \ No newline at end of file + +# Create an EarthScope Account + +To start the registration process, navigate to https://earthscope.org/user . Select "Continue with Google" or "Continue with Cilogon," or if you prefer to use an email and password, click on the "Don't have an account? Sign Up" link instead. + +Either option you choose will bring up a page that has several required fields to fill out: First Name, Last Name, Country, Work Sector, and Institution. If you are *not* currently affiliated with a research or educational institution, type "none" in this box and then click "Save". + +![image](./img/es_user_create.png) + +Finally, click "Register" to complete the process. You may receive an account activation email. Please be aware that this email can take a while to find its way through some institutions' spam filters. Please contact your system administrator or try registering with a different email if you do not receive it and are unable to log in with your new account. + +# Credential and License Management +API Access Credentials and real-time GNSS licenses can be managed on your user account page, https://www.earthscope.org/user/info. \ No newline at end of file diff --git a/es_config/earthscope.yml b/es_config/earthscope.yml new file mode 100644 index 0000000..56ca2fa --- /dev/null +++ b/es_config/earthscope.yml @@ -0,0 +1,31 @@ +# Shared configuration file for all EarthScope repositories that feed into docs.earthscope.org + +version: 1 +project: + open_access: true + license: + content: CC-BY-4.0 + code: Apache-2.0 + +site: + template: book-theme + options: + folders: true + favicon: https://www.earthscope.org/app/uploads/2022/12/cropped-favicon-32x32.png + logo: https://www.earthscope.org/app/uploads/2025/11/NSFNGF-Logo-RGB-Color.svg + logo_dark: https://www.earthscope.org/app/uploads/2025/11/NSFNGF-Logo-RGB-White.svg + logo_url: https://docs.earthscope.org + internal_domains: docs.earthscope.org + + nav: + - title: Home + url: https://docs.earthscope.org + - title: GeoLab + url: https://docs.earthscope.org/projects/GeoLab + # open_in_same_tab: true + - title: API + url: https://docs.earthscope.org/projects/API + # open_in_same_tab: true + - title: SDK + url: https://docs.earthscope.org/projects/SDK + # open_in_same_tab: true \ No newline at end of file diff --git a/_static/ESC_Logo-primary_color_HR.png b/es_config/logos/ESC_Logo-primary_color_HR.png similarity index 100% rename from _static/ESC_Logo-primary_color_HR.png rename to es_config/logos/ESC_Logo-primary_color_HR.png diff --git a/_static/cloud_logo_simple_small.png b/es_config/logos/cloud_logo_simple_small.png similarity index 100% rename from _static/cloud_logo_simple_small.png rename to es_config/logos/cloud_logo_simple_small.png diff --git a/_static/earthscope_favicon_color.png b/es_config/logos/earthscope_favicon_color.png similarity index 100% rename from _static/earthscope_favicon_color.png rename to es_config/logos/earthscope_favicon_color.png diff --git a/intro.md b/intro.md index e1959d5..cbf3103 100644 --- a/intro.md +++ b/intro.md @@ -1,16 +1,12 @@ # Welcome to EarthScope's Cloud Data and Developer Documentation Center! -```{Note} +```{note} This [JupyterBook](https://jupyterbook.org/en/stable/intro.html) is in development as we configure our cloud documentation center. ``` -The EarthScope-operated data systems of the NSF GAGE and SAGE Facilities are migrating to cloud services. With this transition comes new capabilities for users to use cloud computing for their own work. Use the links on this page to explore documentation for using our Cloud Data tools and services + The NSF National Geophysical Facility operated by EarthScope Consortium is migrating to the cloud! + With this transition, users have access to new cloud computing capabilities for their own work. Here you can explore documentation for using our Cloud Data tools and services. + + The navigation bar across the top links to documentation for EarthScope-operated cloud services. Fundamentals for account creation and getting started are on the left sidebar. -Learn more about EarthScope's Cloud Migration by visiting https://www.earthscope.org/data/cloud/ or by contacting us at: data-help (at) earthscope.org - -```{admonition} Projects: -:class: seealso -* GeoLab, EarthScope's JupyterHub: {{ geolab_docs_url }} - -``` \ No newline at end of file +Learn more about EarthScope's Cloud Migration by visiting https://www.earthscope.org/data/cloud/ or by contacting us at: help@earthscope.org \ No newline at end of file diff --git a/myst.yml b/myst.yml new file mode 100644 index 0000000..ae88de1 --- /dev/null +++ b/myst.yml @@ -0,0 +1,32 @@ +version: 1 +extends: + #TODO: update this to static github url + - ./es_config/earthscope.yml +project: + title: EarthScope Cloud Documentation Center + # authors: + # - name: EarthScope On-Ramp Project Group + copyright: '2024-2026' + github: EarthScope/CloudDocs + + toc: + - file: intro.md + # - title: Getting Started + # children: + - file: content/user_account.md + - file: content/citation.md + # - title: EarthScope Cloud Resources + # children: + # - url: https://docs.earthscope.org/projects/GeoLab + # title: GeoLab + # - url: https://docs.earthscope.org/projects/API + # title: EarthScope API + # - url: https://docs.earthscope.org/projects/CLI + # title: EarthScope CLI + # - url: https://docs.earthscope.org/projects/SDK + # title: EarthScope SDK +# site: +# options: +# logo: es_config/logos/cloud_logo_simple_small.png +# folders: true +# template: book-theme