Skip to content

Commit b12aa44

Browse files
committed
fix broken links in docs
1 parent 62d70bc commit b12aa44

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ type-related bugs. The nox session that calls mypy is named analyze.
229229
Documentation is built from Markdown files in the `docs` directory using
230230
[MkDocs](https://www.mkdocs.org/) according to `mkdocs.yml`. The API reference
231231
is auto-populated from code docstrings. These docstrings must be in the
232-
[google format](https://mkdocstrings.github.io/handlers/python/#google-style)
232+
[google format](https://mkdocstrings.github.io/python/usage/docstrings/google/)
233233
(note: we use `Parameters` in our docstrings).
234234

235235
By default, Nox builds the docs along with other CI checks. However, Nox can

design-docs/content-plan.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Add a considerations section to the documentation, either to the getting started
104104

105105
## readme.rst
106106

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

109109
### Ticket to be filed
110110

@@ -193,7 +193,7 @@ Investigate using MkDocs plugin to derive changes.txt items.
193193

194194
### Published
195195

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

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

docs/get-started/venv-tutorial.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ Check the version again to confirm it was installed:
106106
You should see a number that begins with 1.
107107

108108
!!!note "If a version 1 doesn’t appear"
109-
If you don’t see a version 1 number, then you may need to adjust your path. If you have trouble getting the version for the Planet SDK v1 that you know you’ve installed, feel free to [discuss with us](https://github.com/planetlabs/planet-client-python/discussions). We can troubleshoot together and then update the steps here.
109+
If you don’t see a version 1 number, then you may need to adjust your path. If you have trouble getting the version for the Planet SDK v1 that you know you’ve installed, feel free to [discuss with us](https://community.planet.com). We can troubleshoot together and then update the steps here.
110110

111111
#### Deactivate version 1
112112

docs/resources/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The following examples were created specifically to show you how to use the SDK
1010

1111
* [data_download_multiple_assets.py](https://github.com/planetlabs/planet-client-python/blob/main/examples/data_download_multiple_assets.py) - this Python script orders, activates, and downloads two assets
1212
* [orders_create_and_download_multiple_orders.py](https://github.com/planetlabs/planet-client-python/blob/main/examples/orders_create_and_download_multiple_orders.py) - this Python script creates two orders, each with unique Area of Interest (AoI), preventing a combined download
13-
* [Planet API Python Client](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/data-api-tutorials/planet_python_client_introduction.ipynb) - a Python notebook to introduce Planet’s Data API and the `planet` module
13+
* [Planet API Python Client](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/Data-API/planet_python_client_introduction.ipynb) - a Python notebook to introduce Planet’s Data API and the `planet` module
1414
* [Orders API & Planet SDK](https://github.com/planetlabs/notebooks/blob/665f165e59f2c3584976ad2dde569c649e631c0b/jupyter-notebooks/orders_api_tutorials/Planet_SDK_Orders_demo.ipynb) - a Python notebook shows how to get started with Planet SDK and the Orders API.
1515
* [Analysis Ready Data Tutorial Part 1: Introduction and Best Practices](https://github.com/planetlabs/notebooks/blob/6cc220ff6db246353af4798be219ee1fe7e858b0/jupyter-notebooks/analysis-ready-data/ard_1_intro_and_best_practices.ipynb) - this Python notebook uses the SDK to prepare Analysis Ready Data.
1616
* [Analysis Ready Data Tutorial Part 2](https://github.com/planetlabs/notebooks/blob/6cc220ff6db246353af4798be219ee1fe7e858b0/jupyter-notebooks/analysis-ready-data/ard_2_use_case_1.ipynb) - the first use case in this Python notebook leverages the SDK’s `order_request` feature to prepare an NDVI time stack and the second use case visualizes the NDVI imagery.

0 commit comments

Comments
 (0)