nebari-dev / nebari-dev/nebari-docs
[DOC] - Add a glossary of terms
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 21
- Forks
- 40
- Avg merge
- 19h 50m
- Merged PRs (30d)
- 6
Description
Given the number of services and technologies involved in a Nebari deployment, a glossary of terms would be a handy tool enabling all of us (users, devs, etc) to more precisely communicate.
Some other OS projects that have glossaries include:
- https://zero-to-jupyterhub.readthedocs.io/en/latest/resources/glossary.html
- https://kubernetes.io/docs/reference/glossary/?fundamental=true
References to the above might be a good place to start as well.
Contributor guide
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 by reviewing the existing Nebari documentation and the linked Zero to JupyterHub and Kubernetes glossaries. Identify the initial terms from the services and technologies used in a Nebari deployment, add the glossary to the documentation, and verify that it serves users and developers as a shared reference.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws, gcp, kubernetes
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100