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

Documentation Updates for newcomers #36

Open
NickRycar opened this issue Jul 2, 2019 · 0 comments
Open

Documentation Updates for newcomers #36

NickRycar opened this issue Jul 2, 2019 · 0 comments
Labels
documentation non-functional update to docs or how-tos good first issue Good for newcomers

Comments

@NickRycar
Copy link

Ran through some suggestions for the README.md provided by @alainlubin and @danf425. Some high-level topics discussed included:

  • Make sure the instructions call out running a terraform init on a user's first spin-up, as the terraform apply will fail if this is not done
  • Update the sup-log section of local specifying a ctrl+c to exit out when you're done.
  • Guidence on working with branches for contributing or working with PRs (this can likely go in a separate CONTRIBUTING.md)

Thinking of using this as a good topic to get some folks together for a quick contributing session to guide folks through the git-fu required to get changes pushed to the repo.

@NickRycar NickRycar added enhancement New feature or request good first issue Good for newcomers documentation non-functional update to docs or how-tos and removed enhancement New feature or request labels Jul 2, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation non-functional update to docs or how-tos good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant