gruntwork-io / gruntwork-io/boilerplate
More documentation
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 350
- Forks
- 32
- PR merge metrics
- No merged PRs in 30d
Description
Describe the solution you'd like
Some suggestions for what to add:
- a tutorial, get started, how to understand it. Can be pretty basic, like: start with nothing, add these files, this is what you get, add more files, now you get this.. etc.
- a basic how-to do common scenarios, like: base layout and partials. How to use this partials features to solve a particular problem.
- For both of the above: give actual example code.
Describe alternatives you've considered
We could create videos, but the quicker way would be written examples.
Additional context
This came out of a call with a customer using boilerplate internally.
Contributor guide
No contributing guide indexed for this repository
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
The issue names no files, tests, or documentation entry points. Start by reviewing the repository structure and existing documentation, then identify where written tutorials and how-to examples belong. Done means adding practical getting-started and common-scenario guidance with actual example code.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100