nebari-dev / nebari-dev/nebari-docs
[DOC] - Docs heading is inaccurate
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
I believe the docs heading at https://www.nebari.dev/docs/explanations/custom-overrides-configuration#deployment-inside-a-virtual-private-network is inaccurate. Azure VNet or GCP's VPC are not the same thing as a VPN.
Steps to Resolve this Issue
Change "Deployment inside a Virtual Private Network" to "Deployment inside a Azure VNet or VPC"
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 the documentation page at the provided custom-overrides-configuration URL and locate the “Deployment inside a Virtual Private Network” heading under the specified anchor. Update the heading to “Deployment inside a Azure VNet or VPC,” then verify that the rendered documentation shows the corrected wording.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure, gcp
- Domain
- cloud, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100