Skip to content

Commit fed3a54

Browse files
author
Carms Ng
committed
[ADD] instructions to add partner / client
1 parent a9ea48d commit fed3a54

File tree

1 file changed

+55
-16
lines changed

1 file changed

+55
-16
lines changed

README.md

+55-16
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,17 @@ Staging: [coderbunker-staging.netlify.app](https://coderbunker-staging.netlify.a
3535

3636

3737

38-
## How to deploy?
38+
## How to deploy?
3939

4040
### Production (Netlify)
4141

42-
Continuous Deployment on Netlify of the main branch of this repo (i.e. everytime code got merged onto the **main** branch, it will trigger a rebuild on Netlify.
42+
Continuous Deployment on Netlify of the main branch of this repo (i.e. everytime code got merged onto the **main** branch, it will trigger a rebuild on Netlify.
4343

4444
Changes can be seen 👉 [coderbunker.ca](https://coderbunker.ca/)
4545

4646

4747

48-
### Staging
48+
### Staging
4949

5050
You can refer to Netlify deploy preview on the pull request.
5151

@@ -76,13 +76,15 @@ gatsby build
7676

7777
```
7878
coderbunker
79-
├── locales
79+
├── locales
8080
├── src
8181
│ ├── assets
82-
│ │ ├── content 👈 Where team member info is stored
82+
│ │ ├── content
83+
│ │ │ ├── members 👈 Where team member info is stored
84+
│ │ │ └── partners 👈 Where partners (& clients) info is stored
8385
│ │ ├── fonts
8486
│ │ └── images
85-
│ ├── components 👈 reusable components
87+
│ ├── components 👈 reusable components
8688
│   ├── pages
8789
│   │   ├── 404.js
8890
│   │   └── index.js
@@ -100,14 +102,17 @@ coderbunker
100102

101103
### Add a team member
102104

103-
#### Folder Structure
105+
#### Folder Structure
104106

105107
```
106108
├── src
107109
├── assets
108-
└── content // 👈 add team member info here
109-
         ├── 01_ricky_ng_adam.jpg
110-
└── 01_ricky_ng_adam.json
110+
└── content
111+
├── members
112+
│ ├── 01_ricky_ng_adam.jpg 👈 team member portrait
113+
│ └── 01_ricky_ng_adam.json 👈 team member info
114+
└── partners
115+
111116
112117
```
113118
#### JSON File Example
@@ -120,7 +125,7 @@ coderbunker
120125
"linkedin": "https://www.linkedin.com/in/rngadam/",
121126
"github": "https://github.com/rngadam",
122127
"image": "01_ricky_ng_adam.jpg",
123-
"highlights": [
128+
"highlights": [
124129
"25 years experience in software development",
125130
"Architecture, design, R&D",
126131
"Team recruitment, building and coaching",
@@ -151,20 +156,54 @@ coderbunker
151156
```
152157

153158

154-
1. Copy an existing JSON file in the `/content` folder, and rename it following the naming convention i.e. `01_ricky_ng_adam`
159+
1. Copy an existing JSON file in the `/content/members` folder, and rename it following the naming convention i.e. `01_ricky_ng_adam`
160+
161+
2. Add an image to the same folder `/content/members`, make sure the image file name matched what was specified in the json file.
162+
163+
Please keep the highlights short and sweet, max 7 bullet points.
164+
165+
166+
167+
168+
## Partner (& Client) Content
169+
170+
### Add a partner
171+
172+
#### Folder Structure
173+
174+
```
175+
├── src
176+
├── assets
177+
└── content
178+
├── members
179+
└── partners
180+
├── 01_drave.json 👈 partner info
181+
└── 01_drave.png 👈 partner logo
182+
183+
```
184+
#### JSON File Example
185+
186+
```
187+
{
188+
"name": "Drave développement",
189+
"website": "https://drave.quebec/",
190+
"logo": "01_drave.png"
191+
}
192+
193+
```
155194

156-
2. Add an image to the same folder `/content`, make sure the image file name matched what was specified in the json file.
157195

158-
Please keep the highlights short and sweet, max 7 bullet points.
196+
1. Copy an existing JSON file in the `/content/partners` folder, and rename it following the naming convention i.e. `01_drave`
159197

198+
2. Add an image to the same folder `/content/partners`, make sure the image file name matched what was specified in the json file.
160199

161200

162201
## Translation
163202

164203
### add/remove translation strings
165204

166205
```
167-
├── locales
206+
├── locales
168207
└── fr
169-
└── index.json // 👈 non team-member related translation string goes here
208+
└── index.json // 👈 non team-member related translation string goes here
170209
```

0 commit comments

Comments
 (0)