Skip to content

Commit 7f4062e

Browse files
committed
docs: move git-flow under post-installation
1 parent 35cb71e commit 7f4062e

File tree

4 files changed

+71
-46
lines changed

4 files changed

+71
-46
lines changed

docs/pages/articles/deployment.mdx

Lines changed: 3 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -12,50 +12,11 @@ Follow the steps in the **Render Initial Blueprint Instance** section to sync it
1212

1313
## Git Flow
1414

15-
CI/CD using GitHub Actions deploy code updates to the **development** or **production** environments following this [simplified version of Git Flow](https://youtu.be/cV-9KszXEyw?feature=shared&t=845).
15+
CI/CD using GitHub Actions deploy code updates to the **development** or **production** environments following this [simplified version of Git Flow](https://youtu.be/cV-9KszXEyw?feature=shared&t=845). Refer to the [Git Flow](/post-installation/git-flow) page for more information about this process.
1616

17-
<img src="https://firebasestorage.googleapis.com/v0/b/assets-cms.appspot.com/o/users%2FAwryJ0MU8zdxQFh9y0L0x2sSt8z1%2Ffd8YN8jIdC6dikTDYllr_file?alt=media&token=050ea71e-d56c-4844-ad8e-7c796b123b5d" alt="acap-git-flow" style={{ margin: "auto" }} />
18-
19-
20-
**(Optional)** Before proceeding, create a GitHub Issue describing the new feature, bug fix or task that you'll develop. This tracks the details of the incoming updates.
21-
22-
<Steps>
23-
24-
### Create a feature branch
25-
26-
- Create a **feature branch** branching out from the **dev branch**
27-
28-
> If a GitHub Issue describes this feature, name the branch with the GitHub Issue number eg., `feat/acaptutorials-12` (Issue #12)
29-
30-
```sh
31-
git checkout dev
32-
git checkout -b feat/acaptutorials-12
33-
34-
# Using other branch names
35-
# git checkout -b awesome-update
36-
```
37-
38-
- This isolates new work (feature, bug fix, or task) so it doesn't destabilize the shared development branch.
39-
40-
### Merge the feature branch back to dev
41-
42-
- Once the feature is complete and reviewed via a **Pull Request (PR)**, it's merged back into **dev**.
43-
- Approving a PR to the dev branch (or pushing updates directly to the dev branch) triggers a deployment to the **development** (Firebase Hosting, Render and, [Vercel](/articles/deployment-vercel) (if available)) environment.
44-
- It allows testing the feature with other in-progress features in an integrated (development) environment.
45-
- Delete the feature branch afterward to keep the repository clean.
46-
47-
### Promote dev to master
17+
<br />
4818

49-
- When the **dev branch** has accumulated stable, tested features, create a Pull Request (PR) to **master**
50-
- The master branch always reflects the code that's safe to release to production.
51-
52-
### Tag a release
53-
54-
- Tag and version a release from the **master branch** (e.g., v1.0.0).
55-
- This creates an immutable snapshot of the code that corresponds to a specific release.
56-
- It also triggers a deployment to the **production** (GitHub Pages, Render and, [Vercel](/articles/deployment-vercel) (if available)) environment.
57-
58-
</Steps>
19+
<img src="https://firebasestorage.googleapis.com/v0/b/assets-cms.appspot.com/o/users%2FAwryJ0MU8zdxQFh9y0L0x2sSt8z1%2Ffd8YN8jIdC6dikTDYllr_file?alt=media&token=050ea71e-d56c-4844-ad8e-7c796b123b5d" alt="acap-git-flow" style={{ margin: "auto" }} />
5920

6021
## Render Initial Blueprint Instance
6122

docs/pages/post-installation.mdx

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ import { Cards, Card, Callout } from 'nextra/components'
22

33
# Post-Installation
44

5-
These tutorials contain additional post-installation instructions after initially setting up the client and server apps in the [Installation](/installation) section.
5+
These tutorials contain additional post-installation instructions and guidelines after initially setting up the client and server apps in the [Installation](/installation) section.
66

77
<br />
88

9-
### Immediate
9+
### Immediate
1010

1111
<Cards>
1212
<Card title="Web Map / AMIA Villages" href="/post-installation/webmap" />
@@ -17,10 +17,19 @@ These tutorials contain additional post-installation instructions after initiall
1717
<Card title="Opengraph Settings" href="/post-installation/opengraph" />
1818
</Cards>
1919

20-
### Optional
20+
### Optional
2121

2222
<Cards>
2323
<Card title="Province Codes" href="/post-installation/province-codes" />
2424
<Card title="ACAP-RCMAS REST APIs" href="/post-installation/acap-rcmas-api" />
2525
<Card title="Google Search Console" href="/post-installation/google-search" />
2626
</Cards>
27+
28+
<br />
29+
30+
### 💡 During Development
31+
32+
<Cards>
33+
<Card title="Git Flow" href="/post-installation/git-flow" />
34+
<Card title="Site Search" href="/post-installation/site-search" />
35+
</Cards>

docs/pages/post-installation/_meta.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,7 @@
77
"acap-rcmas-api": "ACAP-RCMAS REST APIs",
88
"opengraph": "Opengraph Settings",
99
"google-search": "Google Search Console",
10-
"province-codes": "Province Codes"
10+
"province-codes": "Province Codes",
11+
"git-flow": "Git Flow",
12+
"site-search": "Site Search"
1113
}
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
import { Callout, Steps } from 'nextra/components'
2+
3+
# Git Flow
4+
5+
This page **summarizes the simplified version of Git Flow** branching strategy from the [ACAP video tutorials](https://youtu.be/cV-9KszXEyw?feature=shared&t=845) when developing new features, bug fixes or tasks.
6+
7+
CI/CD using GitHub Actions deploy code updates to the **development** or **production** environments on certain triggers (eg., merging PRs to the dev branch or creating new Releases).
8+
9+
<br />
10+
11+
<img src="https://firebasestorage.googleapis.com/v0/b/assets-cms.appspot.com/o/users%2FAwryJ0MU8zdxQFh9y0L0x2sSt8z1%2Ffd8YN8jIdC6dikTDYllr_file?alt=media&token=050ea71e-d56c-4844-ad8e-7c796b123b5d" alt="acap-git-flow" style={{ margin: "auto" }} />
12+
13+
14+
**(Optional)** Before proceeding, create a GitHub Issue describing the new feature, bug fix or task that you'll develop. This tracks and organizes the details of the incoming updates.
15+
16+
<Steps>
17+
18+
### Create a feature branch
19+
20+
- Create a **feature branch** branching out from the **dev branch**
21+
22+
> If a GitHub Issue describes this feature, name the branch with the GitHub Issue number eg., `feat/acaptutorials-12` (Issue #12)
23+
24+
```sh
25+
git checkout dev
26+
git checkout -b feat/acaptutorials-12
27+
28+
# Using other branch names
29+
# git checkout -b awesome-update
30+
```
31+
32+
- This isolates new work (feature, bug fix, or task) so it doesn't destabilize the shared development branch.
33+
34+
### Merge the feature branch back to dev
35+
36+
- Once the feature is complete and reviewed via a **Pull Request (PR)**, it's merged back into **dev**.
37+
- Approving a PR to the dev branch (or pushing updates directly to the dev branch) triggers a deployment to the **development** (Firebase Hosting, Render and, [Vercel](/articles/deployment-vercel) (if available)) environment.
38+
- It allows testing the feature with other in-progress features in an integrated (development) environment.
39+
- Delete the feature branch afterward to keep the repository clean.
40+
41+
### Promote dev to master
42+
43+
- When the **dev branch** has accumulated stable, tested features, create a Pull Request (PR) to **master**
44+
- The master branch always reflects the code that's safe to release to production.
45+
46+
### Tag a release
47+
48+
- Tag and version a release from the **master branch** (e.g., v1.0.0).
49+
- This creates an immutable snapshot of the code that corresponds to a specific release.
50+
- It also triggers a deployment to the **production** (GitHub Pages, Render and, [Vercel](/articles/deployment-vercel) (if available)) environment.
51+
52+
</Steps>
53+

0 commit comments

Comments
 (0)