nebari-dev / nebari-dev/nebari-docs
[DOC] - Dask docs for end users are (mostly) not discoverable via search
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 21
- Forks
- 40
- Avg merge
- 19h 50m
- Merged PRs (30d)
- 6
Description
Preliminary Checks
- This issue is not a question, feature request, RFC, or anything other than a bug report. Please post those things in GitHub Discussions: https://github.com/nebari-dev/nebari/discussions
Summary
- Go to nebari.dev.
- Search for "dask".
- No end user docs show up.
None of the displayed docs are for end users:
I was confused because I KNOW we have docs. After poking around quite a bit I realized that if I typed "dask worker", I could get the end user docs to show up in the search. However, people are not likely going to do that and it took me forever to figure that out.
This shows how I got it to show up ("Working with big data and dask" is our only end user doc):
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
Reproduce the search on nebari.dev with “dask” and compare it with “dask worker,” then inspect how “Working with big data and dask” is indexed. Done means an end user searching for “dask” can find the end-user documentation without needing a more specific query.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, search
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100