Skip to content

Commit 62d70bc

Browse files
committed
migrate static doc ref, developers.pl to doc.pl
1 parent 1e87935 commit 62d70bc

22 files changed

+79
-87
lines changed

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,21 @@
55

66
The [Planet](https://planet.com) Software Development Kit (SDK) for Python
77
provides both a Python API and a command-line interface (CLI)
8-
to make use of [the Planet APIs](https://developers.planet.com/docs/apis/).
8+
to make use of [the Planet APIs](https://docs.planet.com/develop/apis/).
99
Everything you need to get started is found in our
1010
[online documentation](https://planet-sdk-for-python-v2.readthedocs.io/en/latest/).
1111

1212
Version 2.0 includes support for the core workflows of the following APIs:
1313

14-
* [Data](https://developers.planet.com/docs/data/) - Search for imagery from Planet's data catalog.
15-
* [Orders](https://developers.planet.com/docs/orders/) - Process and download or deliver imagery.
16-
* [Subscriptions](https://developers.planet.com/docs/subscriptions/) - Set up a search to auto-process and deliver imagery.
17-
* [Features](https://developers.planet.com/docs/apis/features/) - Upload areas of interest to the Planet platform.
14+
* [Data](https://docs.planet.com/develop/apis/data/) - Search for imagery from Planet's data catalog.
15+
* [Orders](https://docs.planet.com/develop/apis/orders/) - Process and download or deliver imagery.
16+
* [Subscriptions](https://docs.planet.com/develop/apis/subscriptions/) - Set up a search to auto-process and deliver imagery.
17+
* [Features](https://docs.planet.com/develop/apis/features/) - Upload areas of interest to the Planet platform.
1818

1919
After the initial 2.0 release there will be additional work to support the
20-
remaining Planet APIs: [basemaps](https://developers.planet.com/docs/basemaps/),
21-
[tasking](https://developers.planet.com/docs/tasking/) and
22-
[analytics](https://developers.planet.com/docs/analytics/).
20+
remaining Planet APIs: [basemaps](https://docs.planet.com/develop/apis/basemaps/),
21+
[tasking](https://docs.planet.com/develop/apis/tasking/) and
22+
[analytics](https://docs.planet.com/develop/apis/analytics/).
2323

2424
## Versions and Stability
2525

design-docs/CLI-Data.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Data Command-Line Interface Specification
22

33
This document lays out the command-line interface to interact with the Planet
4-
[Data API](https://developers.planet.com/docs/apis/data/).
4+
[Data API](https://docs.planet.com/develop/apis/data/).
55

66
## Meta: Errors
77

design-docs/CLI-Orders.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Orders Command-Line Interface Specification
22

33
This document lays out the command-line interface to interact with the Planet
4-
[Orders API](https://developers.planet.com/docs/orders/).
4+
[Orders API](https://docs.planet.com/develop/apis/orders/).
55

66
## list
77

design-docs/CLI-Subscriptions.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Subscriptions Command-Line Interface Specification
22

33
This documents lays out the command-line interface to interact with the
4-
Planet [Subscriptions API](https://developers.planet.com/docs/subscriptions/reference/)
4+
Planet [Subscriptions API](https://docs.planet.com/develop/apis/subscriptions/)
55

66
A subscription connects catalog sources to a data processing pipeline. It can
77
run those tools on new data when it is available. It can process existing data
@@ -21,8 +21,8 @@ be easier to design and implement.
2121

2222
**Essential reading:**
2323

24-
https://developers.planet.com/docs/subscriptions/reference/
25-
https://developers.planet.com/docs/subscriptions/
24+
https://docs.planet.com/develop/apis/subscriptions/
25+
https://docs.planet.com/develop/apis/subscriptions/reference/
2626

2727
**Commands:**
2828

@@ -272,11 +272,10 @@ Options:
272272

273273
Edit a subscription, such as one with a future start date, before it starts running.
274274

275-
https://developers.planet.com/docs/subscriptions/#edit-a-subscription mentions
276275
caveats and limitations:
277-
* Backfill cannot be updated.
278-
* After a subscription is running, only source items can be modified, and not
279-
all of them.
276+
* After a subscription transitions to running, changes to the start_time and item_types fields are not allowed.
277+
* The edit will only apply to future item publications and deliveries and no items will be redelivered.
278+
* Backfill subscriptions cannot be edited.
280279

281280

282281
### Interface

design-docs/content-plan.md

+10-15
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,18 @@ For a complete list of the project board, source, and current documentation buil
1313

1414
## A note regarding location of qualification documentation:
1515

16-
The SDK and CLI are low-level interfaces mirroring much of the API, itself. While this documentation should make it easy for developers to use the SDK and CLI, core Planet API concepts, clarifying content, and considerations might be better located in the core API documentation on [Planet](https://developers.planet.com/docs/apis/), and then linked to from content produced here.
16+
The SDK and CLI are low-level interfaces mirroring much of the API, itself. While this documentation should make it easy for developers to use the SDK and CLI, core Planet API concepts, clarifying content, and considerations might be better located in the core API documentation on [Planet](https://docs.planet.com/develop/apis/), and then linked to from content produced here.
1717

1818
## SSoT
1919

20-
We are currently publishing documentation on [planet.com](https://developers.planet.com/docs/pythonclient/), [github.io](https://planetlabs.github.io/planet-client-python/index.html), [github wiki](https://github.com/planetlabs/planet-client-python/wiki), and on [readthedocs.com](https://planet-sdk-for-python.readthedocs.io/en/latest/). Providing a single source of truth (SSoT) ensures one definitive source of documentation, reducing the dilution of information, errors, and maintenance efforts.
20+
We are currently publishing documentation on [planet.com](https://docs.planet.com/develop/sdks/#planet-sdk-for-python-and-cli), [github.com](https://github.com/planetlabs/planet-client-python), and on [readthedocs.com](https://planet-sdk-for-python-v2.readthedocs.io). Providing a single source of truth (SSoT) ensures one definitive source of documentation, reducing the dilution of information, errors, and maintenance efforts.
2121

2222
### Ticket to be filed
2323

2424
Implement mkdocs to leverage features of readthedocs.com, but publish only on one platform. This would be planet.com unless we are making a concerted effort to recruit 3rd party contributors to the SDK, in which case, it could stay on readthedocs.com. So the publication landscape would be as follows:
2525

2626
* Publish the SDK V2 documentation on readthedocs.com.
27-
* Do not mirror the SDK V2 documentation on developers.planet.com.
27+
* Do not mirror the SDK V2 documentation on docs.planet.com.
2828
* End-of-life the GitHub wiki content for V2, and rely on the readme, the contributing, the changes, and the published documentation to convey information published at the wiki in 2017.
2929
* End-of-life the github.io channel for V2, and rely on readthedocs.com as the single source of truth.
3030

@@ -42,7 +42,7 @@ Provide a getting started experience that presumes the user has not used an SDK
4242

4343
Provide a relational visualization (e.g.: a dashboard of sorts) of the SDK, CLI, and API, and link to the landing page for each.
4444

45-
Platform overview documentation should be created on the DevCenter to explain the SDK and CLI in the context of the other Planet offerings, within the Planet platform. (This is an internal ticket on developers.planet.com, not the SDK GitHub project issues list.) The SDK should reference this overview.
45+
Platform overview documentation should be created on the DevCenter to explain the SDK and CLI in the context of the other Planet offerings, within the Planet platform. (This is an internal ticket on docs.planet.com, not the SDK GitHub project issues list.) The SDK should reference this overview.
4646

4747
## Code snippets
4848

@@ -197,7 +197,7 @@ Investigate using MkDocs plugin to derive changes.txt items.
197197

198198
[GitHub Wiki](https://github.com/planetlabs/planet-client-python/wiki)
199199

200-
[SDK Devcenter landing page](https://developers.planet.com/open/)
200+
[SDK Devcenter landing page](https://docs.planet.com/)
201201

202202
[planet · PyPI](https://pypi.org/project/planet/)
203203

@@ -213,23 +213,18 @@ Investigate using MkDocs plugin to derive changes.txt items.
213213

214214
[https://github.com/planetlabs/planet-client-python/](https://github.com/planetlabs/planet-client-python/)
215215

216-
#### Current V2 docs (erroneously tagged V1.4.9)
217-
[https://planet-sdk-for-python.readthedocs.io/en/latest/](https://planet-sdk-for-python.readthedocs.io/en/latest)
218-
219-
#### Current V1.4.9 docs
220-
[https://developers.planet.com/docs/pythonclient/](https://developers.planet.com/docs/pythonclient/)
216+
#### Current V2 docs
217+
[https://planet-sdk-for-python-v2.readthedocs.io/](https://planet-sdk-for-python-v2.readthedocs.io/)
218+
#### V1.4.9 docs
219+
[https://planet-sdk-for-python.readthedocs.io/en/latest/](https://planet-sdk-for-python.readthedocs.io)
221220

222221
and
223222

224223
[https://planetlabs.github.io/planet-client-python/index.html](https://planetlabs.github.io/planet-client-python/index.html)
225224

226-
#### Current V1.4.9 docs source
225+
#### V1.4.9 docs source
227226
[https://github.com/planetlabs/planet-client-python/tree/master/docs](https://github.com/planetlabs/planet-client-python/tree/master/docs)
228227

229-
and
230-
231-
[https://github.com/planetlabs/planet-client-python//docs](https://github.com/planetlabs/planet-client-python//docs)
232-
233228
## GitHub flavored markdown
234229

235230
This document was created using [GitHub flavored markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#GitHub-flavored-markdown)

docs/cli/cli-data.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ title: CLI for Data API Tutorial
44

55
## Introduction
66

7-
The `planet data` CLI commands enable interaction with the [Data API](https://developers.planet.com/docs/apis/data/),
7+
The `planet data` CLI commands enable interaction with the [Data API](https://docs.planet.com/develop/apis/data/),
88
which lets you search Planet’s catalog (including select public datasets like Sentinel 2 and Landsat 8).
99
Currently the CLI has focused on the core search functionality, implementing
10-
[Quick Search](https://developers.planet.com/docs/apis/data/reference/#tag/Item-Search/operation/QuickSearch)
11-
and [stats](https://developers.planet.com/docs/apis/data/reference/#tag/Item-Stats/operation/Stats) plus some
10+
[Quick Search](https://docs.planet.com/develop/apis/data/reference/#tag/Item-Search/operation/QuickSearch)
11+
and [stats](https://docs.planet.com/develop/apis/data/reference/#tag/Item-Stats/operation/Stats) plus some
1212
partial saved search functionality.
1313

1414
## `data search` command basics
@@ -87,8 +87,8 @@ This outputs the last 100 scenes.
8787

8888
### Search on Item Type
8989

90-
These first searches were done on the [PSScene](https://developers.planet.com/docs/data/psscene/) 'item type', but you
91-
can use any [Item Type](https://developers.planet.com/docs/apis/data/items-assets/#item-types) that Planet offers in
90+
These first searches were done on the [PSScene](https://docs.planet.com/data/imagery/planetscope/psscene/) 'item type', but you
91+
can use any [Item Type](https://docs.planet.com/develop/apis/data/items/#item-types) that Planet offers in
9292
its catalog. The item type is the first argument of the `search` command, followed by the 'filter'. Note that
9393
you can specify any number of item types here:
9494

@@ -318,8 +318,8 @@ planet data filter --asset ortho_analytic_8b_sr --asset udm2 \
318318
```
319319

320320
You can find the list of available assets in each Item Type Page, like
321-
[available assets](https://developers.planet.com/docs/data/psscene/#available-asset-types) for PSScene. You can see
322-
[a table of all Item Types](https://developers.planet.com/docs/data/psscene/#available-asset-types), which links to
321+
[available assets](https://docs.planet.com/data/imagery/planetscope/psscene/) for PSScene. You can see
322+
[a table of all Item Types](https://docs.planet.com/develop/apis/data/items/#item-types), which links to
323323
the page for each with their list of asset types.
324324

325325
Note that the asset filter doesn't perform any validation, so if your searches aren't returning anything check to make
@@ -494,7 +494,7 @@ be faster for working with a small number of items & assets.
494494
### Activate an Asset
495495

496496
All items in the Data API have a list of assets. This includes the main imagery geotiff files, usually in a few
497-
different formats, and also accompanying files like the [Usable Data Mask](https://developers.planet.com/docs/data/udm-2/)
497+
different formats, and also accompanying files like the [Usable Data Mask](https://docs.planet.com/data/imagery/udm/)
498498
(UDM) and JSON metadata. You can't immediately download them, as they must first be created in the cloud, known as
499499
'activated'. To activate data you need to get its item id, plus the name of the asset - the available ones
500500
can be seen by looking at the Item’s JSON. Once you have the item id and asset type you can run the CLI
@@ -542,7 +542,7 @@ Download has a few different options:
542542
## Saved Searches
543543

544544
The core `planet data search` command uses what is called a 'quick search' in the API. The API
545-
also supports what we call a '[saved searches](https://developers.planet.com/docs/apis/data/quick-saved-search/#saved-search)',
545+
also supports what we call a '[saved searches](https://docs.planet.com/develop/apis/data/item-search/#saved-search)',
546546
and the CLI supports this as well.
547547

548548
### List Searches

docs/cli/cli-guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ One of the commands you’ll use most frequently is `planet data filter`. This
110110
planet data filter --permission --std-quality
111111
```
112112

113-
Look at the console output to see some default filters. `PermissionFilter` filters the output to only contain imagery that you have permission to download. You’ll also see `quality_category`, which means the output lists only images in the [`standard quality` category](https://developers.planet.com/docs/data/planetscope/#image-quality-standard-vs-test-imagery). Without these options, an empty filter is generated which would be used to disable filtering and simply return all results.
113+
Look at the console output to see some default filters. `PermissionFilter` filters the output to only contain imagery that you have permission to download. You’ll also see `quality_category`, which means the output lists only images in the [`standard quality` category](https://docs.planet.com/data/imagery/planetscope/#standard-versus-test-imagery). Without these options, an empty filter is generated which would be used to disable filtering and simply return all results.
114114

115115
!!!note "The --help switch is your friend"
116116
You can do a lot with this `filter` command. We recommend running `planet data filter --help` often to get a reference of how the commands work.

docs/cli/cli-intro.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ responses are all textual. For more on what a command-line is see
1313
## Why would I use Planet’s CLI?
1414

1515
Planet offers a number of ways to interact with its API’s, from
16-
[Planet Explorer](https://developers.planet.com/docs/apps/explorer/), which is a full
17-
web-based GUI, to [plug-ins for QGIS](https://developers.planet.com/docs/integrations/qgis/)
18-
and [ArcGIS Pro](https://developers.planet.com/docs/integrations/arcgis/) for those who want
16+
[Planet Explorer](https://docs.planet.com/platform/get-started/access-data/), which is a full
17+
web-based GUI, to [plug-ins for QGIS](https://docs.planet.com/platform/integrations/qgis)
18+
and [ArcGIS Pro](https://docs.planet.com/platform/integrations/arcgis/) for those who want
1919
to stay in their desktop GIS environment.
2020

2121
The Planet CLI offers more direct interaction with the API’s, as its commands more directly

0 commit comments

Comments
 (0)