CLI tutorials #642
CLI tutorials #642
Conversation
This reverts commit a353d3a.
There was a problem hiding this comment.
First off, I learned a lot reading through this. Thank you for putting together such a concise and helpful guide. I did notice that our story on the - input is inconsistent. I would like to see if we can get more consistent. Right now I am pretty sure the dash is not required for any required arguments that are JSON. so e.g. orders create doesn't require the dash (ref). data search ([ref](@click.argument("filter", type=types.JSON(), default="-", required=False))) and data search-create don't require the dash either.
docs/cli-plus-tutorial.md
Outdated
| awesome kepler.gl library from the commandline. Useful for visualization of large amounts of | ||
| geojson. | ||
| * **[GeoJSON.io](https://geojson.io/)** - Simple tool to do editing of geojson, useful for creating | ||
| AOI's. Integrates with github, but doesn't seem to work so well. |
There was a problem hiding this comment.
This statement makes me curious. In what ways does it not seem to work well?
There was a problem hiding this comment.
Ah, it's the integration with github that's not working well. I'll clarify it. If I hit 'save' on geojson.io (like to gist or to github) I get an authentication failure, and can't seem to actually hook up my github account. This used to work before. If it worked then geojson.io would be a lot better for the command-line flows. I kinda work around it with the gh cli usage. Curious if you're able to 'save' - if I just got into some weird state, or if it's basically broken for everyone.
|
|
||
| The 'permission filter' is set to true by default, since most people want to search only for data they have access to | ||
| and are able to download. But if you'd like to just get search Planet's catalog and get a sense of what is out there | ||
| you can set the permission filter to false: |
There was a problem hiding this comment.
how does this work? They have to have an api key to do anything, right? And if they have an api key then what is the limitation on their download access?
There was a problem hiding this comment.
Maybe I have this wrong? Yes, they need an API key, but I was thinking if 'permission filter' was set to true then they'd only see data api results in the AOI that they have purchased access to. And if they wanted to search outside then they'd need to set it to false?
Though now I'm questioning - how does the permission filter work? What is the effect of setting it to true or false?
This is one of those times it'd be nice to easily test the non-planeteer experience.
There was a problem hiding this comment.
hmm yeah I agree it would be helpful to be able to test different scenarios. @sarasafavi is there any way for devrel to get a set of tester API keys?
docs/cli-tutorial.md
Outdated
| ``` | ||
|
|
||
| Or get the 5 latest cloud free images in an area and create an order that clips to that area, using | ||
| [geometry.geojson](https://gist.github.com/cholmes/378d050a263ae433ddbbb91c3439994b) from above: |
There was a problem hiding this comment.
would be cool to host this on the sdk repo
There was a problem hiding this comment.
Would be happy to, what would the advantage be?
There was a problem hiding this comment.
just seems more permanent and maybe professional than your personal GH account. Like having an office number with a secretary that answers instead of a cellphone? IDK 😆
There was a problem hiding this comment.
I'm halfway done with this, but it'll be better when I merge to main, so I'm going to just do another PR once this one is merged to finish it off.
Co-authored-by: Jennifer Reiber Kyle <[email protected]>
Co-authored-by: Jennifer Reiber Kyle <[email protected]>
Co-authored-by: Jennifer Reiber Kyle <[email protected]>
|
Merging this in - future updates will just be done as new PR's |
This PR contains three tutorial docs.
One thing I'm less sure of is if markdown in this directory automatically shows up in the docs? Or do I need to include the files in some table of contents somewhere? Help appreciated on this, and I'll also try to dig in more on it.
Closes #595