Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README to include comprehensive local deploy, test, and build steps #2346

Closed
wants to merge 2 commits into from

Conversation

tylergraff
Copy link
Contributor

Reference Issues or PRs

What does this implement/fix?

Put a x in the boxes that apply

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds a feature)
  • Breaking change (fix or feature that would cause existing features not to work as expected)
  • Documentation Update
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • Other (please describe):

Testing

  • Did you test the pull request locally?
  • Did you add new tests?

Any other comments?

Copy link
Member

@krassowski krassowski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if adding this (or making improvements in general) to https://www.nebari.dev/docs/how-tos/nebari-local/ (in https://github.com/nebari-dev/nebari-docs) would be more maintainable.


Add to hosts file specific resolutions for .local domains specified above
```
echo -e "\n172.18.1.100 local-dev.example.local\n172.18.1.100" example.local\n | sudo tee -a /etc/hosts
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not always as simple (nebari-dev/nebari-docs#403).

@marcelovilla
Copy link
Member

@tylergraff I also think it makes more sense to add this to the docs rather than the README. Do you have the bandwith to do that?

@tylergraff
Copy link
Contributor Author

Yes, I have bandwidth to move this to the docs. I'll cut a PR there and tag you for review.

@tylergraff tylergraff closed this May 10, 2024
@krassowski
Copy link
Member

FYI there might be some overlap with nebari-dev/nebari-docs#449

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

3 participants