fix(docs): implement github-flow (#57)

hadenlabs · Dec 30, 2024 · f88797d · f88797d
1 parent 98ea985
commit f88797d
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 13 deletions.
diff --git a/docs/commands.md b/docs/commands.md
@@ -79,6 +79,8 @@ task version:minor
 task version:patch
 ```
 
+## Infrastructure
+
 ### Terragrunt
 
 | Field |        Description        |

diff --git a/docs/contributing.md b/docs/contributing.md
@@ -12,20 +12,20 @@ Contributions to base-template are welcome.
 
 Feel free to use all of the contribution options:
 
-- Contribute to base-template repositories on [GitHub](https://github.com/hadenlabs/base-template). See [Git flow](./contribute/github-flow.md).
+- Contribute to base-template repositories on [GitHub](https://github.com/hadenlabs/base-template). See [GitHub flow](./contribute/github-flow.md).
 
 ## Getting Started
 
 ### Development
 
-In general, MRs are welcome. We follow the typical "fork-and-pull" [Git flow](./contribute/github-flow.md).
+In general, MRs are welcome. We follow the typical "fork-and-pull" [Github flow](./contribute/github-flow.md).
 
-1.  **Fork** the repo on Github
-2.  **Clone** the project to your own machine
-3.  **Commit** changes to your own branch using [Git flow](./contribute/github-flow.md)
-4.  **Push** your work back up to your fork
+1. **Fork** the repo on Github
+2. **Clone** the project to your own machine
+3. **Commit** changes to your own branch using [Github Flow](./contribute/github-flow.md)
+4. **Push** your work back up to your fork
 
-5.  Submit a **Pull Request** so that we can review your changes
+5. Submit a **Pull Request** so that we can review your changes
 
 **NOTE:** Be sure to rebase the latest changes from "upstream" before making a pull request!
 
@@ -69,7 +69,7 @@ Examples commit messages:
 
 ### Branches
 
-See [Git flow](./contribute/github-flow.md).
+See [Github Flow](./contribute/github-flow.md).
 
 ### Documentation
 

diff --git a/docs/examples/common.md b/docs/examples/common.md
@@ -5,4 +5,10 @@
 <!-- Include: ./../disclaimer.md -->
 <!-- Include: ac:toc -->
 
-### Common
+## Common
+
+### Install Dependencies
+
+```bash
+task setup
+```
diff --git a/docs/roadmap.md b/docs/roadmap.md
@@ -51,7 +51,3 @@ You can see the corresponding projects on [base-template](https://github.com/had
 ### December 2021
 
 ## Long Lived Initiatives
-
-These projects don't have an end date. They are something we'll continuously work towards.
-
-- [Better Docs](https://hadenlabs.atlassian.net/wiki)