Skip to content

Commit fec92ae

Browse files
author
Carms Ng
authored
Updated team member info management instructions
1 parent 35074fd commit fec92ae

File tree

1 file changed

+64
-46
lines changed

1 file changed

+64
-46
lines changed

README.md

+64-46
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ Production: [coderbunker.ca](https://coderbunker.ca/)
77

88
Staging: [coderbunker-staging.netlify.app](https://coderbunker-staging.netlify.app/)
99

10+
11+
1012
## Framework
1113

1214
* [Gatsby](https://www.gatsbyjs.com/)
@@ -15,6 +17,8 @@ Staging: [coderbunker-staging.netlify.app](https://coderbunker-staging.netlify.a
1517
* [styled-components](https://styled-components.com/)
1618
* [Netlify](https://www.netlify.com/)
1719

20+
21+
1822
## Asset Attribution
1923

2024
* [DrawKit](https://www.drawkit.io)
@@ -29,6 +33,8 @@ Staging: [coderbunker-staging.netlify.app](https://coderbunker-staging.netlify.a
2933
* Refer to this [issue](https://github.com/coderbunker/coderbunker.ca/issues/1)
3034
* Phase 2: To be envisioned
3135

36+
37+
3238
## How to deploy?
3339

3440
### Production (Netlify)
@@ -37,14 +43,13 @@ Continuous Deployment on Netlify of the main branch of this repo (i.e. everytime
3743

3844
Changes can be seen 👉 [coderbunker.ca](https://coderbunker.ca/)
3945

40-
To be added to Netlify, contact [email protected]
4146

42-
### Staging
4347

44-
You can refer to Netlify preview on the pull request.
48+
### Staging
4549

46-
Alternatively, you can use gh-pages 👉 [coderbunker.github.io/coderbunker.ca](https://coderbunker.github.io/coderbunker.ca/)
50+
You can refer to Netlify deploy preview on the pull request.
4751

52+
You can use gh-pages as an alternative 👉 [coderbunker.github.io/coderbunker.ca](https://coderbunker.github.io/coderbunker.ca/)
4853

4954
```
5055
gatsby clean
@@ -65,25 +70,22 @@ or
6570
gatsby build
6671
```
6772

73+
74+
6875
## Structure of code
6976

7077
```
7178
coderbunker
7279
├── locales
7380
├── src
7481
│ ├── assets
75-
│ │ ├── content
82+
│ │ ├── content 👈 Where team member info is stored
7683
│ │ ├── fonts
7784
│ │ └── images
78-
│   │      └── portraits // 👈 add team member image here
79-
│ ├── components
80-
│   │   ├── button.js
81-
│   │   └── // 👈 add reusable components, etc...
85+
│ ├── components 👈 reusable components
8286
│   ├── pages
8387
│   │   ├── 404.js
8488
│   │   └── index.js
85-
│   ├── pdfs
86-
│   │   └── placeholder.pdf
8789
│   └── styles
8890
├── gatsby-browser.js
8991
├── gatsvy-config.js
@@ -96,57 +98,73 @@ coderbunker
9698

9799
## Team Content
98100

99-
#### Add a team member
101+
### Add a team member
100102

101-
1. Add an image in the `team` folder.
102-
103-
- Name the images following the format starting with `002`
104-
- it will be displayed as part of the stacked avatar and the team carousel if included in the team.json.
103+
#### Folder Structure
105104

106105
```
107106
├── src
108107
├── assets
109-
├── content
110-
│ └── team.json // 👈 add team member info here
111-
├── images
112-
         └── portraits // 👈 add team member image here
113-
         ├── 001_ricky_ng_adam.jpg
114-
         └── 002_etc...
115-
```
108+
└── content // 👈 add team member info here
109+
         ├── 01_ricky_ng_adam.jpg
110+
└── 01_ricky_ng_adam.json
116111
117-
2. Add a slide to the team carousel
112+
```
113+
#### JSON File Example
118114

119115
```
120116
{
121-
"content": [
122-
{
123-
"name": "Ricky Ng-Adam",
124-
"title": "Founder, CoderBunker",
125-
"linkedin": "https://www.linkedin.com/in/rngadam/",
126-
"github": "https://github.com/rngadam",
127-
"image": "001_ricky_ng_adam.jpg", // 👈 reference the image in the `team` folder
128-
"highlights": [ // 👈 optimal length <= 7
129-
"25 years experience in software development",
130-
"Architecture, design, R&D",
131-
"Team recruitment, building and coaching",
132-
"Javascript, Python, C/C++, bash, plpgsql",
133-
"API: REST, Websockets, GraphQL",
134-
"Deployment (Linux, Ansible, Cloud, Docker)",
135-
"Database (PostgreSQL)"
136-
]
137-
},
138-
{ ...next member }
139-
]
117+
"en": {
118+
"name": "Ricky Ng-Adam",
119+
"title": "Founder, Coderbunker",
120+
"linkedin": "https://www.linkedin.com/in/rngadam/",
121+
"github": "https://github.com/rngadam",
122+
"image": "01_ricky_ng_adam.jpg",
123+
"highlights": [
124+
"25 years experience in software development",
125+
"Architecture, design, R&D",
126+
"Team recruitment, building and coaching",
127+
"Javascript, Python, C/C++, bash, plpgsql",
128+
"API: REST, Websockets, GraphQL",
129+
"Deployment (Linux, Ansible, Cloud, Docker)",
130+
"Database (PostgreSQL)"
131+
]
132+
},
133+
"fr": {
134+
"name": "Ricky Ng-Adam",
135+
"title": "Fondateur, chez Coderbunker",
136+
"linkedin": "https://www.linkedin.com/in/rngadam/",
137+
"github": "https://github.com/rngadam",
138+
"image": "01_ricky_ng_adam.jpg",
139+
"highlights": [
140+
"25 ans d'expérience dans le développement de logiciels",
141+
"Architecture, design, R&D",
142+
"Recrutement d'équipe, constitution et coaching",
143+
"Javascript, Python, C/C++, bash, plpgsql",
144+
"API: REST, Websockets, GraphQL",
145+
"Déploiement (Linux, Ansible, Cloud, Docker)",
146+
"Base de données (PostgreSQL)"
147+
]
148+
}
140149
}
150+
141151
```
142152

153+
154+
1. Copy an existing JSON file in the `/content` folder, and rename it following the naming convention i.e. `01_ricky_ng_adam`
155+
156+
2. Add an image to the same folder `/content`, make sure the image file name matched what was specified in the json file.
157+
158+
Please keep the highlights short and sweet, max 7 bullet points.
159+
160+
161+
143162
## Translation
144163

145-
#### add/remove translation strings
164+
### add/remove translation strings
146165

147166
```
148167
├── locales
149168
└── fr
150-
├── team.json // 👈 add FR string specific to the team member info
151-
└── index.json // 👈 add the rest of the FR string
169+
└── index.json // 👈 non team-member related translation string goes here
152170
```

0 commit comments

Comments
 (0)