nebari-dev / nebari-dev/nebari-docs
[BUG] - Inconsistency in the Deploy Nebari on local machines guide
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 21
- Forks
- 40
- Avg merge
- 19h 50m
- Merged PRs (30d)
- 6
Description
Describe the bug
In the Deploy Nebari on local machines (for testing) guide of the documentation, it is clearly stated that:
🔥warning
Currently, Nebari does not support local mode on Windows and macOS.
However, there is a tip in the Initializing Nebari section with the following information:
💡tip
The main temp folder on a MacOS system can be found by inspecting the value of $TMPDIR. This folder and its files are not meant to be user-facing and will present you with a seemingly random directory path similar to /var/folders/xx/xxxxx/T
I believe this comes from other How-to Guides (e.g., Deploy Nebari on AWS) but should not be in this particular guide.
Expected behavior
If macOS is not supported for local deployments, I don't see the relevance of having a tip refering to the temp folder in macOS.
How to Reproduce the problem?
Go to the Initializing Nebari of the Deploy Nebari on local machines (for testing) guide. This can found here in the source code.
Command output
No response
Versions and dependencies used.
No response
Anything else?
No response
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
Open docs/docs/how-tos/nebari-local.md and inspect the Initializing Nebari section around lines 83–87. Align the macOS temp-folder tip with the guide’s stated platform support, then verify the rendered guide no longer contains conflicting guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- macos
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100