Merge pull request #322 from ASFHyP3/develop

Release v0.3.70
ASFHyP3 · May 16, 2023 · 81b5ca9 · 81b5ca9
2 parents 255e69b + 36ed9c3
commit 81b5ca9
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 1 deletion.
diff --git a/.github/workflows/check-links.yml b/.github/workflows/check-links.yml
@@ -9,7 +9,7 @@ jobs:
 
       - name: Link Checker
         id: lychee
-        uses: lycheeverse/lychee-action@v1.7.0
+        uses: lycheeverse/lychee-action@v1.8.0
         env:
           GITHUB_TOKEN: ${{secrets.TOOLS_BOT_PAK}}
         with:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [PEP 440](https://www.python.org/dev/peps/pep-0440/) 
 and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.3.70]
+
+### Added
+* Documented public visibility of jobs in the Using HyP3 section.
+* Added link to tutorial on searching for other users' jobs.
+
 ## [0.3.69]
 
 ### Added

diff --git a/docs/tutorials.md b/docs/tutorials.md
@@ -6,6 +6,8 @@ We provide step-by-step tutorials for using HyP3 programmatically via Jupyter No
 
 * [Using the HyP3 Python SDK](https://nbviewer.jupyter.org/github/ASFHyP3/hyp3-sdk/blob/main/docs/sdk_example.ipynb "Using the HyP3 SDK Tutorial" ){target=_blank}
   -- This notebook walks through ordering and accessing RTC, InSAR, and autoRIFT products in Python using the HyP3 SDK.
+* [Using the HyP3 SDK to search for jobs run by another user](https://nbviewer.jupyter.org/github/ASFHyP3/hyp3-sdk/blob/main/docs/search_other_user_jobs.ipynb "Using the HyP3 SDK to search for jobs run by another user" ){target=_blank}
+  -- This notebook walks through using the HyP3 SDK to search for jobs run by another user.
 * [Time series analysis with HyP3 and MintPy](https://nbviewer.org/github/ASFHyP3/hyp3-docs/blob/main/docs/tutorials/hyp3_insar_stack_for_ts_analysis.ipynb "Time series analysis with HyP3 and MintPy Tutorial" ){target=_blank}
   -- This notebook walks through performing a time-series analysis of the 2019 
   Ridgecrest, CA earthquake with HyP3 On Demand InSAR products and MintPy.

diff --git a/docs/using-snippet.md b/docs/using-snippet.md
@@ -14,3 +14,15 @@ Requesting and downloading On Demand products can also be done programmatically:
 
 * [HyP3 SDK for Python](using/sdk.md "Using SDK")
 * [HyP3 REST API](using/api.md "Using API")
+
+### Public Visibility of Jobs
+
+!!! warning
+
+    All jobs submitted to HyP3, whether via web access or programmatic access, are publicly visible.
+    Anyone with access to HyP3 can potentially:
+
+    * View your jobs and associated metadata, including job name and user ID.
+    * Download any products generated by your jobs.
+
+    In particular, do not include any sensitive information in your job names.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -70,6 +70,7 @@ nav:
   - Tutorials:
     - tutorials.md
     - Using HyP3 Python SDK: https://nbviewer.jupyter.org/github/ASFHyP3/hyp3-sdk/blob/main/docs/sdk_example.ipynb" target="_blank
+    - Search another user's jobs: https://nbviewer.jupyter.org/github/ASFHyP3/hyp3-sdk/blob/main/docs/search_other_user_jobs.ipynb" target="_blank
     - InSAR time series with MintPy: https://nbviewer.jupyter.org/github/ASFHyP3/hyp3-docs/blob/main/docs/tutorials/hyp3_insar_stack_for_ts_analysis.ipynb" target="_blank
     - StoryMap Tutorials: https://asf-daac.maps.arcgis.com/home/index.html" target="_blank
   - Other Tools: