nebari-dev / nebari-dev/nebari-docs
[DOC] - How to add custom link to top bar
Open
Nobody has claimed this yet.
area: documentation 📖
- 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
On this top bar, we'd like to add a custom link to user-facing documentation, ie how to use the hub, conda-store etc.
We are not using jhub apps which would be configured here
@viniciusdc suggested in the in the community meeting the first thing to try would be
jupyterhub:
overrides:
hub:
services:
custom-doc: url
```
(services dict syntax may not be quite like that) 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 with the referenced 02-spawner.py file and the JupyterHub configuration shown in the issue, checking how the hub's services dictionary is structured. Document the supported configuration for adding a user-facing custom link to the top bar, including the correct services syntax and an example URL.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kubernetes, yaml
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100