Skip to content
Merged
Changes from 1 commit
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
91da7b6
delete labelmaker
matthew-ballard Oct 16, 2025
5154a03
delete tpdi notebook
matthew-ballard Oct 16, 2025
e95fe41
delete temporal-analysis use case
matthew-ballard Oct 16, 2025
8ee4b5d
delete field_statistical_analysis notebook
matthew-ballard Oct 16, 2025
866c2df
create api_guides folder, move basemaps
matthew-ballard Oct 16, 2025
b594ac2
move data_api
matthew-ballard Oct 16, 2025
065fdca
move features api to api_guides
matthew-ballard Oct 16, 2025
4b8f05f
move orders_api to api_guides
matthew-ballard Oct 16, 2025
ea52fb0
move statistical_api to api_guides
matthew-ballard Oct 16, 2025
3639e31
move subscriptions_api to api_guides and rename
matthew-ballard Oct 16, 2025
26a7f14
move tasking_api to api_guides
matthew-ballard Oct 16, 2025
4144114
move tile_services to api_guides
matthew-ballard Oct 16, 2025
4f1583d
move batch_processing_api to api_guides
matthew-ballard Oct 16, 2025
d9134b2
move analytics_api to api_guides
matthew-ballard Oct 16, 2025
870e887
move around use_cases and workflows
matthew-ballard Oct 16, 2025
35df5ad
reorganize workflows
matthew-ballard Oct 16, 2025
a0ab72d
reorganize use_cases
matthew-ballard Oct 16, 2025
1e6e8eb
ordering, snake case
matthew-ballard Oct 16, 2025
91203b8
add readme to notebooks folder
matthew-ballard Oct 16, 2025
ee6c0c3
update contributing guide
matthew-ballard Oct 16, 2025
34acc83
delete unused tests
matthew-ballard Oct 16, 2025
83b3802
update readmes
matthew-ballard Oct 16, 2025
a38282d
add TOC
matthew-ballard Oct 16, 2025
cbfe4a6
contributing.md feeback
matthew-ballard Oct 21, 2025
75574c8
update readmes
matthew-ballard Oct 21, 2025
d241e95
capitalization
matthew-ballard Oct 21, 2025
09523db
Further revise auth guidance in README.md
tbarsballe Oct 21, 2025
fa15d11
Merge branch '392-restructure-fy26q3' of https://github.com/planetlab…
matthew-ballard Oct 22, 2025
669433d
add sandbox data description to TOC
matthew-ballard Oct 22, 2025
1b6198c
move colab to first thing in notebooks
matthew-ballard Oct 22, 2025
982b4a6
update colab links with new structure
matthew-ballard Oct 22, 2025
78219a0
update orders to data collection remove SH
matthew-ballard Oct 24, 2025
1e36c98
remove sandbox tag
matthew-ballard Oct 29, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
contributing.md feeback
  • Loading branch information
matthew-ballard committed Oct 21, 2025
commit cbfe4a662324c6b71843ae3d80ebb98bf8446430
10 changes: 8 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,25 @@ If you are contributing a notebook, we've gathered these style guide requirement

Notebook filenames should not have spaces. Please use underscores with `snake_case` instead for all files in the repository.

Your filename should align to the title of the notebook. For example, a notebook titled **Generate Agriculture Index Time Series** should be `generate_agriculture_index_time_series.ipynb`.

### HTML and Markdown

For maximum portability, accessibility, and ease of use, notebooks in this repository should not use a custom style or theme. Please stick to standard markdown features so that it works across all environments.

### Dependencies

When a new notebook has a dependency that is not yet supported by the Docker image, please add the dependency to the [Docker setup requirements](planet-notebook-docker/requirements.txt).
When a new notebook has a dependency that is not yet supported by the Docker image, please add the dependency to the [Docker setup requirements file](planet-notebook-docker/requirements.txt).

Alternatively, you can choose to add package installation instructions in your Notebook, particularly if the notebook you are adding has any heavy, unique, or tricky dependencies. If you do this, make sure to include comments in the notebooks.

### Ordering Notebooks

If you are working on a multi-part guide that has several notebooks, prefix the notebooks with `1_`, `2_`, `3_`, and so on to indicate the order.

### Optimize Cell Outputs for Viewing in the Browser

If you have a cell that prints a very large json repsonse, consider alternative ways to view the data. Could it be viewed in a table or on a map? Very large json repsonses make notebooks difficult to read in GitHub.
If you have a cell that prints a very large json repsonse, consider alternative ways to view the data. Could it be viewed in a table or on a map? Very large json repsonses make notebooks difficult to read.

### Use Colab

Expand All @@ -36,6 +40,8 @@ For example:
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github//planetlabs/notebooks/blob/master/jupyter-notebooks/workflows/planet_sandbox_data/agriculture-index-time-series/agriculture-index-time-series.ipynb)
```

If your notebook includes Colab link, make sure that the packages used within it are either a) default colab packages or b) imported using a magic command `%pip install planet`.

### Introduction

For a notebook, please make sure to include context and description at the top using this format:
Expand Down