removing redundant getting started docs #39
Conversation
the main getting started docs are provided (as a single markdown file) here, and that is deployed to oras-www. The remaining content here is about contributing / development, and I am also adding links between them so it is easy to find the right one Signed-off-by: vsoch <[email protected]>
| steps, and please open an issue if functionality is missing. | ||
| steps, and please [open an issue](https://github.com/oras-project/oras-py/issues) if | ||
| functionality is missing. More detailed developer examples can also be found on the | ||
| [Oras Python](https://oras-project.github.io/oras-py/) page hosted alongside the repository. |
There was a problem hiding this comment.
Do you think it will be better to combine Oras Python to the official website? People might be easier to find ORAS-python from a unified documentation portal.
There was a problem hiding this comment.
Just noticed you are working on migrating the docs from oras-py to the ORAS website. Let me know if you need assistance.
There was a problem hiding this comment.
That's the entire point of this PR - the file here 1_python.md is grabbed and deployed to the official site! It should be done after these two are merged.
There was a problem hiding this comment.
This kills two birds with one stone because the corresponding docs are alongisde the respective code (e.g., as I'm updating the library here I can update them) but then nightly they are grabbed and deployed to oras-www. Here is the page here deployed there: https://oras.land/client_libraries/1_python/ and the PR here is removing the redundant docs from here.
| your own custom interactions. | ||
| your own custom interactions. The main getting started docs can be found on | ||
| `oras.land Python's page <https://oras.land/client_libraries/1_python/>`_ and | ||
| the developer user guide (and more detailed examples) can be found here. |
There was a problem hiding this comment.
developer user guide => developer guide?
There was a problem hiding this comment.
I meant to say "developer user" - a developer user is not a user of the client, but a developer developing with it. I guess maybe it sounds weird, but in my mind:
- developer: sort of referring to a main maintainer (will likely respond to issues / fix bugs)
- developer user: using someone else's SDK, etc, (will likely open issues / report bugs)
- user: typically someone that is just, for example, running the client (but not developing anything)
|
Thank you @FeynmanZhou ! Let me know if you have other questions or suggestions for changes. |
The main getting started docs are provided (as a single markdown file) here, and that s deployed to oras-www. The remaining
content here is about contributing / development, and I am also adding links between them so it is easy to find the right one
Signed-off-by: vsoch [email protected]