source-cooperative / source-cooperative/docs.source.coop
Documentation items to add (what got skipped for PR #7)
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1
- Forks
- 2
- Avg merge
- 25m
- Merged PRs (30d)
- 2
Description
Here's a list of things we need to address that we didn't have time for in #7:
- Add examples of how to access for Docs should provide examples of these (with links), to clearly demonstrate how efficient it is.
- Need a more clear AWS CLI example (only current example is shown on the data-proxy page)
- boto3 is not demonstrated
- "bring your compute directly to the data in the cloud" is not demonstrated
- The "Future Data Product Features" section has a discussion of "Restricted Access". Won't this violate this Key Principle of Open Access?
- data-proxy.md page may need to be updated to reflect alternative workflows that use OpenID Connect (OIDC).
- we did not touch the data upload page either, might need to be redone
- add the product Memberships page to be described in the docs.
Ex: https://source.coop/edit/product/account/product-id/memberships
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with data-proxy.md and the existing AWS CLI example, then review the data upload page and the product Memberships page linked in the issue. Document clearer AWS CLI and boto3 access examples, explain the listed compute and OIDC workflows, and resolve the open-access discussion and missing Memberships coverage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws, python
- Domain
- cloud, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100