Skip to content

Commit 900ef56

Browse files
committed
finalize analytics_feeds notebook and update CONTRIBUTING to address subscriptions
1 parent 39ebfea commit 900ef56

File tree

2 files changed

+47
-6
lines changed

2 files changed

+47
-6
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,16 @@ When a new notebook has a dependency that is not yet supported by the Docker ima
1313
a new Docker image must be built. Additionally, add the new dependency to the
1414
[imports_test notebook](dev/imports_test.ipynb).
1515

16-
## Area of Interest
16+
## Planet Feeds
17+
18+
It is the intention of this notebook repository that a user be able to easily
19+
determine the permissions needed within the Planet ecosystem to be able to run
20+
all notebooks successfully. Therefore, we standardize and track the Planet feeds
21+
that are used across all notebooks within this repository. Right now, this applies
22+
to the Planet Data feed in the form of Areas of Interest and to the Planet
23+
Analytics feed in the form of suscription IDs.
24+
25+
### Data Feed - Area of Interest
1726

1827
The first choice of area of interest (AOI) for any notebook is an AOI that is
1928
already used in this repository. The geojson description of these AOIs is given
@@ -30,7 +39,23 @@ add the AOI to the
3039
[repository_aois notebook](dev/repository_aois.ipynb). Run that notebook
3140
through to the end to update [aois.geojson](dev/imports_test.ipynb).
3241

33-
## Skipping Validation
42+
### Analytics Feed - Subscription ID
43+
44+
The fist choice of Analytics Feed subscription id for any notebooks is a
45+
subscription ID that is already used in this repository. The subscription IDs
46+
used in this repository are maintained in the
47+
[analygics_feeds notebook](analytics_feeds.ipynb). This notebook also helpfully
48+
pulls the feed information from these subscription IDs. It is good practice
49+
to add your notebook to the list of notebooks using each subscription ID.
50+
51+
Currently, subscription IDs are not being tracked in any demo permissions program.
52+
However, this may change in the future. If the subscription ID for a notebook
53+
cannot be satisfied by the subscription IDs already in the repository, add
54+
the subscription ID to the notebook and email <[email protected]> to notify us
55+
of the change. (**NOTE**: this is likely to change to a request when demo
56+
permissions for the analytics feed are established).
57+
58+
## Notebook Validation
3459

3560
To enable validation of the Docker image, every notebook should run successfully
3661
when run from the command line. For notebooks where that just is not possible,

dev/analytics_feeds.ipynb

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
11
{
22
"cells": [
3+
{
4+
"cell_type": "markdown",
5+
"metadata": {},
6+
"source": [
7+
"# Analytics Feeds\n",
8+
"\n",
9+
"This notebook maintains a list of analytics feeds used in this repository."
10+
]
11+
},
312
{
413
"cell_type": "code",
5-
"execution_count": 41,
14+
"execution_count": 1,
615
"metadata": {},
716
"outputs": [],
817
"source": [
@@ -26,9 +35,16 @@
2635
"]"
2736
]
2837
},
38+
{
39+
"cell_type": "markdown",
40+
"metadata": {},
41+
"source": [
42+
"## Get feeds from subscription ids"
43+
]
44+
},
2945
{
3046
"cell_type": "code",
31-
"execution_count": 42,
47+
"execution_count": 2,
3248
"metadata": {},
3349
"outputs": [],
3450
"source": [
@@ -40,7 +56,7 @@
4056
},
4157
{
4258
"cell_type": "code",
43-
"execution_count": 43,
59+
"execution_count": 3,
4460
"metadata": {},
4561
"outputs": [],
4662
"source": [
@@ -52,7 +68,7 @@
5268
},
5369
{
5470
"cell_type": "code",
55-
"execution_count": 45,
71+
"execution_count": 4,
5672
"metadata": {},
5773
"outputs": [
5874
{

0 commit comments

Comments
 (0)