You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: design-docs/content-plan.md
+10-15
Original file line number
Diff line number
Diff line change
@@ -13,18 +13,18 @@ For a complete list of the project board, source, and current documentation buil
13
13
14
14
## A note regarding location of qualification documentation:
15
15
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.
17
17
18
18
## SSoT
19
19
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.
21
21
22
22
### Ticket to be filed
23
23
24
24
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:
25
25
26
26
* 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.
28
28
* 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.
29
29
* End-of-life the github.io channel for V2, and rely on readthedocs.com as the single source of truth.
30
30
@@ -42,7 +42,7 @@ Provide a getting started experience that presumes the user has not used an SDK
42
42
43
43
Provide a relational visualization (e.g.: a dashboard of sorts) of the SDK, CLI, and API, and link to the landing page for each.
44
44
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.
46
46
47
47
## Code snippets
48
48
@@ -197,7 +197,7 @@ Investigate using MkDocs plugin to derive changes.txt items.
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)
Copy file name to clipboardExpand all lines: docs/cli/cli-guide.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -110,7 +110,7 @@ One of the commands you’ll use most frequently is `planet data filter`. This
110
110
planet data filter --permission --std-quality
111
111
```
112
112
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.
114
114
115
115
!!!note "The --help switch is your friend"
116
116
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.
0 commit comments