Skip to content

Documentation Updates for newcomers #36

@NickRycar

Description

@NickRycar

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationnon-functional update to docs or how-tosgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions