Skip to content

Commit d33da9a

Browse files
Merge pull request #75 from nasa/dek/updates
Docs cleanup: logo update & contributing consolidation
2 parents 8eb445e + fb20bbf commit d33da9a

4 files changed

Lines changed: 40 additions & 42 deletions

File tree

README.md

Lines changed: 2 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -26,41 +26,8 @@ quarto preview # live-preview the site at localhost
2626
```
2727

2828
See the [Contributing Guide](https://nasa.github.io/ASDC_Data_and_User_Services/contributing.html)
29-
for notebook style and content guidelines.
30-
31-
### Environment files
32-
33-
This repo has two environment definitions. They serve different purposes:
34-
35-
| File | Managed by | Purpose |
36-
|------|------------|---------|
37-
| `pyproject.toml` / `uv.lock` | `uv` | **Local development.** All packages needed to run every notebook. Use `uv sync` to install. |
38-
| `environment.yml` | conda (CI only) | **Site builds.** Minimal Jupyter kernel so Quarto can render pre-executed notebooks. You should not need this locally. |
39-
40-
Quarto is configured with `freeze: true`, which means it never re-executes
41-
notebook code during a build. It converts the already-rendered `.ipynb` outputs
42-
straight to HTML. This keeps CI fast and avoids the need for data access
43-
credentials in the build environment.
44-
45-
### Pre-commit hooks
46-
47-
The pre-commit configuration runs on every commit:
48-
49-
- **gitleaks** — secret detection
50-
- **ruff** — Python linting and formatting
51-
- **markdown-link-check** — broken link detection
52-
- **check-notebook-headers** — validates required sections (summary, prerequisites, author)
53-
- **check-notebook-imports** — cross-references imports against `pyproject.toml` (warn-only)
54-
55-
See [`.git-hooks/README.md`](.git-hooks/README.md) for details on the custom
56-
notebook hooks.
57-
58-
## Data files
59-
60-
Notebooks should fetch data programmatically at runtime (e.g., via
61-
`earthaccess` or `harmony-py`) rather than committing data files to the
62-
repository. Large files such as `.nc`, `.hdf`, and `.h5` are not tracked
63-
by git and should stay that way.
29+
for notebook style guidelines, content requirements, pre-commit hooks, and data
30+
file policy.
6431

6532
## Questions or issues?
6633

_images/asdc-logo.png

33.9 KB
Loading

_quarto.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ website:
1919
left: "Atmospheric Science Data Center"
2020

2121
sidebar:
22-
logo: "https://www.earthdata.nasa.gov/themes/custom/project/hds_earthdata/nasa-earthdata-logo.png"
22+
logo: "_images/asdc-logo.png"
2323
pinned: true
2424
align: center
2525
tools:

additional_quarto_docs/contributing.qmd

Lines changed: 37 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,55 @@ date: last-modified
55
citation_url: https://nasa.github.io/ASDC_Data_and_User_Services/contributing.html
66
---
77

8-
*This contributing guide is a draft, and still under active, open development.*
8+
*This contributing guide is under active development.*
99

10-
### Style Guidelines
10+
## Style guidelines
1111

1212
The following are recommended and/or enforced via the CI/CD workflow:
1313

14-
- **Python Version**: This project requires Python 3.10 or higher. All code and notebooks should be compatible with Python 3.10+.
14+
- **Python version** Python 3.10 or higher. All code and notebooks should be compatible with Python 3.10+.
1515
- Use `ruff` for linting and formatting.
1616
- Wherever possible and appropriate, move inline comments into notebook Markdown cells.
1717
- Wherever possible and appropriate, replace static references to local files with code that will programmatically pull data files when running a notebook.
1818

19-
### Content Guidelines
19+
## Content guidelines
2020

2121
Ensure each notebook contains, at a minimum:
2222

23-
- A quarto header with an auto-generated "last published" date included
23+
- A Quarto header with an auto-generated "last published" date included
2424
- A Markdown header section with:
2525
- A **Summary** or **Overview** block
2626
- A **Prerequisites** block
2727
- A **Notebook Author/Affiliation** block
28-
- Numbered sections that use Markdown hash symbols (#) for headings
28+
- Numbered sections that use Markdown hash symbols (`#`) for headings
29+
30+
## Data files
31+
32+
Notebooks should fetch data programmatically at runtime (e.g., via
33+
`earthaccess` or `harmony-py`) rather than committing data files to the
34+
repository. Large files such as `.nc`, `.hdf`, and `.h5` are not tracked
35+
by git and should stay that way.
36+
37+
## Environment files
38+
39+
This repo has two environment definitions. They serve different purposes:
40+
41+
| File | Managed by | Purpose |
42+
|------|------------|----------|
43+
| `pyproject.toml` / `uv.lock` | `uv` | **Local development.** All packages needed to run every notebook. Use `uv sync` to install. |
44+
| `environment.yml` | conda (CI only) | **Site builds.** Minimal Jupyter kernel so Quarto can render pre-executed notebooks. You should not need this locally. |
45+
46+
Quarto is configured with `freeze: true`, which means it never re-executes
47+
notebook code during a build. It converts the already-rendered `.ipynb` outputs
48+
straight to HTML. This keeps CI fast and avoids the need for data access
49+
credentials in the build environment.
50+
51+
## Pre-commit hooks
52+
53+
The pre-commit configuration runs on every commit:
54+
55+
- **gitleaks** — secret detection
56+
- **ruff** — Python linting and formatting
57+
- **markdown-link-check** — broken link detection
58+
- **check-notebook-headers** — validates required sections (summary, prerequisites, author)
59+
- **check-notebook-imports** — cross-references imports against `pyproject.toml` (warn-only)

0 commit comments

Comments
 (0)