Skip to content

migrate static doc ref #1114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 16, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ type-related bugs. The nox session that calls mypy is named analyze.
Documentation is built from Markdown files in the `docs` directory using
[MkDocs](https://www.mkdocs.org/) according to `mkdocs.yml`. The API reference
is auto-populated from code docstrings. These docstrings must be in the
[google format](https://mkdocstrings.github.io/handlers/python/#google-style)
[google format](https://mkdocstrings.github.io/python/usage/docstrings/google/)
(note: we use `Parameters` in our docstrings).

By default, Nox builds the docs along with other CI checks. However, Nox can
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,21 @@

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

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

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

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

## Versions and Stability

Expand Down
2 changes: 1 addition & 1 deletion design-docs/CLI-Data.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Data Command-Line Interface Specification

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

## Meta: Errors

Expand Down
2 changes: 1 addition & 1 deletion design-docs/CLI-Orders.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Orders Command-Line Interface Specification

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

## list

Expand Down
13 changes: 6 additions & 7 deletions design-docs/CLI-Subscriptions.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Subscriptions Command-Line Interface Specification

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

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

**Essential reading:**

https://developers.planet.com/docs/subscriptions/reference/
https://developers.planet.com/docs/subscriptions/
https://docs.planet.com/develop/apis/subscriptions/
https://docs.planet.com/develop/apis/subscriptions/reference/

**Commands:**

Expand Down Expand Up @@ -272,11 +272,10 @@ Options:

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

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


### Interface
Expand Down
29 changes: 12 additions & 17 deletions design-docs/content-plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,18 @@ For a complete list of the project board, source, and current documentation buil

## A note regarding location of qualification documentation:

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.
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.

## SSoT

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.
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.

### Ticket to be filed

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:

* Publish the SDK V2 documentation on readthedocs.com.
* Do not mirror the SDK V2 documentation on developers.planet.com.
* Do not mirror the SDK V2 documentation on docs.planet.com.
* 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.
* End-of-life the github.io channel for V2, and rely on readthedocs.com as the single source of truth.

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

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

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.
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.

## Code snippets

Expand Down Expand Up @@ -104,7 +104,7 @@ Add a considerations section to the documentation, either to the getting started

## readme.rst

The [current readme file](https://github.com/planetlabs/planet-client-python%23readme) follows industry standards and is adequate.
The [current readme file](https://github.com/planetlabs/planet-client-python/blob/main/README.md) follows industry standards and is adequate.

### Ticket to be filed

Expand Down Expand Up @@ -193,11 +193,11 @@ Investigate using MkDocs plugin to derive changes.txt items.

### Published

[Readme](https://github.com/planetlabs/planet-client-python/tree/ef8a27178d21316256ef8a5de6ee6d0758be981c%23readme)
[Readme](https://github.com/planetlabs/planet-client-python/blob/main/README.md)

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

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

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

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

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

#### Current V2 docs (erroneously tagged V1.4.9)
[https://planet-sdk-for-python.readthedocs.io/en/latest/](https://planet-sdk-for-python.readthedocs.io/en/latest)

#### Current V1.4.9 docs
[https://developers.planet.com/docs/pythonclient/](https://developers.planet.com/docs/pythonclient/)
#### Current V2 docs
[https://planet-sdk-for-python-v2.readthedocs.io/](https://planet-sdk-for-python-v2.readthedocs.io/)
#### V1.4.9 docs
[https://planet-sdk-for-python.readthedocs.io/en/latest/](https://planet-sdk-for-python.readthedocs.io)

and

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

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

and

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

## GitHub flavored markdown

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)
18 changes: 9 additions & 9 deletions docs/cli/cli-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ title: CLI for Data API Tutorial

## Introduction

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

## `data search` command basics
Expand Down Expand Up @@ -87,8 +87,8 @@ This outputs the last 100 scenes.

### Search on Item Type

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

Expand Down Expand Up @@ -318,8 +318,8 @@ planet data filter --asset ortho_analytic_8b_sr --asset udm2 \
```

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

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

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

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

### List Searches
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/cli-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ One of the commands you’ll use most frequently is `planet data filter`. This
planet data filter --permission --std-quality
```

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.
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.

!!!note "The --help switch is your friend"
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.
Expand Down
6 changes: 3 additions & 3 deletions docs/cli/cli-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ responses are all textual. For more on what a command-line is see
## Why would I use Planet’s CLI?

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

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