nebari-dev / nebari-dev/nebari-docs

[DOC] - Incorrect Nebari URLs listed in Deploy Nebari to <Provider> pages

Open
#595 0 comments 0 reactions 0 assignees View on GitHub

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
Summary

From testing deploying Nebari to AWS, I discovered the following:

The examples in Deploy Nebari on AWS shows the resulting deployed Nebari URL as a combination of projectname + domain, whereas it's just the domain itself that's used instead, the project_name variable is not used.

I discovered this by cross-referencing the example in Advanced Configuration, which shows the project_name of 'demo' being repeated in the value of the domain variable of 'demo.nebari.dev'. I found this after running into some issues with my deployment because I'd left off the prefix for my domain variable, thinking that project_name would be prepended.

I assume project_name could be anything, although I haven't actually tested this.

Correct example in Advanced Configuration > General Configuration Settings:

### General configuration ###
project_name: demo
namespace: dev
provider: gcp
domain: demo.nebari.dev

Incorrect example in Deploying Nebari on AWS > Deploying Nebari:

Services:
 - argo-workflows -> https://projectname.domain/argo/
 - conda_store -> https://projectname.domain/conda-store/
 - dask_gateway -> https://projectname.domain/gateway/
 - jupyterhub -> https://projectname.domain/
 - keycloak -> https://projectname.domain/auth/
 - monitoring -> https://projectname.domain/monitoring/

If this is right, I'll submit a PR to remove 'projectname' from the various provider docs that include the above example.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by searching the provider documentation for projectname.domain and compare those examples with the Advanced Configuration > General Configuration Settings page. Update the listed service URLs to use the configured domain without the project-name prefix, then verify the affected provider pages no longer show the incorrect examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, gcp
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.