Merge pull request #21 from nsidc/da94-improve-docs

Da94 improve docs

Author: trey-stafford

CODE_OF_CONDUCT.md

@@ -0,0 +1,42 @@
+# Code of Conduct
+
+## 1. Our Commitment
+
+We are dedicated to fostering a respectful environment for everyone contributing
+to this project. We expect all participants to treat each other with respect,
+professionalism, and kindness.
+
+## 2. Expected Behavior
+
+- Be respectful and considerate of others.
+- Engage in constructive discussions and offer helpful feedback.
+- Gracefully accept constructive criticism.
+
+## 3. Unacceptable Behavior
+
+The following behaviors will not be tolerated:
+
+- Harassment, discrimination, or intimidation of any kind.
+- Offensive, abusive, or derogatory language and actions.
+- Personal attacks or insults.
+- Trolling or disruptive conduct.
+- Sharing inappropriate content.
+
+## 4. Reporting Violations
+
+If you experience or witness any behavior that violates this Code of Conduct,
+please report it by contacting the project maintainers. All reports will be
+reviewed confidentially.
+
+## 5. Enforcement
+
+Violations of this Code of Conduct may result in actions such as warnings,
+temporary bans, or permanent exclusion from participation at the discretion of
+the maintainers.
+
+## Contact Info
+
+Email: <nsidc@nsidc.org> Organization: National Snow and Ice Data Center¹
+Website: <https://nsidc.org/> Date last modified: 01-22-2025
+
+¹Work performed under NASA contract 80GSFC23CA035.

LICENSE

@@ -0,0 +1,21 @@
+This software was developed by the National Snow and Ice Data Center (NSIDC) at
+CIRES at the University of Colorado with funding from NASA under Contract
+Number 80GSFC23CA035.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+This permission notice shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,114 +1,34 @@
+<p align="center">
+  <img alt="NSIDC logo" src="https://nsidc.org/themes/custom/nsidc/logo.svg" width="150" />
+</p>
+
 # Data Access Tool (DAT) Backend
 
 Backend services for the
 [Data Access Tool UI](https://github.com/nsidc/data-access-tool-ui).
 
-This repository provides:
-
-- A Flask-based API provides:
-
-* The`python_script.py` download script for data granules matching a user's
-  filters.
-* The
-  [getLinks](https://github.com/nasa/earthdata-download/blob/main/docs/GET_LINKS.md)
-  service required for DAT integration with the
-  [NASA Earthdata Downloader](https://github.com/nasa/earthdata-download).
-
-- Docker compose configuration for the DAT backend, which includes
-  [nginx server configuration](./nginx).
-
-## Background
-
-This service was originally a part of the
-[hermes-api](https://bitbucket.org/nsidc/hermes-api/src). It was moved to a
-standalone service to support the decommissioning of ECS and the rest of the
-hermes stack planned for July 2026.
-
-## Dev
-
-### Pre-commit
-
-This project uses [pre-commit](https://pre-commit.com/) to run pre-commit hooks
-that check and format this project's code for stylistic consistency (e.g., using
-`ruff` and `black`) .
-
-The pre-commit configuration for this project can be found in
-`.pre-commit-config.yaml`. Configuration for specific tools (e.g., `vulture`) is
-given in the included `pyproject.toml`.
-
-For more information about using `pre-commit`, please sese the
-[Scientific Python Library Development Guide's section on pre-commit](https://learn.scientific-python.org/development/guides/gha-basic/#pre-commit).
-
-To install pre-commit to run checks for each commit you make:
-
-```
-$ pre-commit install
-```
-
-To manually run the pre-commit hooks without a commit:
-
-```
-$ pre-commit run --all-files
-```
-
-> [!NOTE] GitHub actions are configured to run pre-commit for all PRs and pushes
-> to the `main` branch. See
-> [.github/workflows/pre-commit.yml](.github/workflows/pre-commit.yml).
-
-### Running tests
-
-Before manually running tests, setup the `EARTHDATA_USERNAME` and
-`EARTHDATA_PASSWORD` envvars, which are necessary for integration tests.
-
-Next, to run all tests:
-
-```
-scripts/run_tests.sh
-```
-
-> [!NOTE] GitHub actions are configured to run unit tests that do not require
-> Earthdata login credentials for all PRs and pushes to the `main` branch. See
-> [.github/workflows/test.yml](.github/workflows/test.yml).
-
-### Testing the EDD integration
-
-An example deep-link to initiate EDD downloads:
-
-In integration (note: for the get-links query param, the `cmr_request_params`
-were url-encoded, and then the entire URL was url-encoded):
+## Level of Support
 
-```
-earthdata-download://startDownload?getLinks=https%3A//integration.nsidc.org/apps/data-access-tool/api/get-links%3Fcmr_request_params%3Dprovider%253DNSIDC_CPRD%2526page_size%253D5%2526sort_key%255B%255D%253D-start_date%2526sort_key%255B%255D%253Dproducer_granule_id%2526short_name%253DATL06%2526version%253D6%2526version%253D06%2526version%253D006%2526temporal%255B%255D%253D2018-10-14T00%253A00%253A00Z%252C2025-02-25T00%253A25%253A20Z%2526bounding_box%253D-180%252C-90%252C180%252C90%2526options%255Bproducer_granule_id%255D%255Bpattern%255D%253Dtrue%2526producer_granule_id%255B%255D%253D%252AATL06_2024%252A_0804%252A_006_01.h5%252A&downloadId=atl06_06&clientId=data_access_tool&authUrl=https://integration.nsidc.org/apps/data-access-tool/api/earthdata/auth?eddRedirect=earthdata-download%3A%2F%2FauthCallback
-```
+This repository is fully supported by NSIDC. If you discover any problems or
+bugs, please submit an Issue. If you would like to contribute to this
+repository, you may fork the repository and submit a pull request.
 
-A button needs to be added to the Data Access Tool that will issue a GET request
-that looks like the above.
+See the [LICENSE](LICENSE) for details on permissions and warranties. Please
+contact nsidc@nsidc.org for more information.
 
-The GET request to `earthdata-download://startDownload` should include the
-following query parameters:
+## Requirements
 
-- `getLinks`: URI for `/api/get-links/`. This URI will specify the
-  `cmr_request_params` query-parameter, which is a string representing the CMR
-  query parameters mapping to a user's selections in the DAT.
-- `downloadId`: The dataset ID and version for the current order (e.g., ATL06 v6
-  is `atl06_06`)
-- `authUrl`: URI for `/api/earthdata/auth/`. EDD will use this to initiate a
-  token exchange with URS to authenticate user downloads. This URL must include
-  `eddRedirect=earthdata-download%3A%2F%2FauthCallback` as a query parameter.
+- [Docker](https://www.docker.com/) and
+  [docker compose](https://docs.docker.com/compose/)
+- Access to NSIDC's internal Virtual Machine infrastructure. It is expected that
+  this backend system be deployed via the
+  [data-access-tool-vm](https://github.com/nsidc/data-access-tool-vm) project.
 
-> [!WARNING] As of this writing, the CMR query parameters are hard-coded to
-> always return a small subset of ATL06 v6 data.
+## Contributing
 
-## Releasing
+Contributing documentation can be viewed by running `quarto preview docs/`
 
-To release a new version:
+## Credit
 
-- Make changes on a branch
-- Update CHANGELOG for next release
-- Run `bump-my-version bump {major|minor|patch}`
-- Open a PR and have it merged to `main` after review
-- Tag latest commit on `main` with the version, and push. This will trigger a
-  build of the `data-access-tool-api` and `data-access-tool-server` images with
-  the given version tag.
-- Deploy the latest change with the
-  [data-access-tool-vm](https://github.com/nsidc/data-access-tool-vm).
+This content was developed by the National Snow and Ice Data Center with funding
+from multiple sources.

doc/.gitignore

@@ -0,0 +1,2 @@
+/.quarto/
+/_site/

doc/_quarto.yml

@@ -0,0 +1,33 @@
+project:
+  type: website
+
+website:
+  title: "Data Access Tool Backend Documentation"
+  site-url: "https://nsidc.github.io/data-access-tool-backend"
+  repo-url: &repo-url "https://github.com/nsidc/data-access-tool-backend"
+  repo-actions: ["edit", "issue"]
+  navbar:
+    left:
+      - href: getting_started.md
+        text: "Getting Started"
+      - href: testing.md
+        text: "Testing"
+      - href: developing_with_edd.qmd
+        text: "Developing with EDD"
+      - href: envvars.md
+      - href: logs.md
+      - href: releasing.md
+      - href: docs.md
+        text: "Docs"
+
+  page-footer:
+    left: "© NSIDC 2025"
+    right: "Built with [Quarto](https://quarto.org/)"
+
+format:
+  html:
+    theme:
+      - cosmo
+      - brand
+    css: styles.css
+    toc: true