Skip to content

Commit 52bb173

Browse files
authored
Merge pull request #107 from CivicDataLab/dev
Dev
2 parents e6656b6 + 4bad1fc commit 52bb173

File tree

2 files changed

+38
-8
lines changed

2 files changed

+38
-8
lines changed

README.md

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
## Run it locally
1414

1515
Prerequisites: NodeJS must be installed on your machine.
16+
1617
1. Clone this repo.
1718
2. Run `npm start` command inside the root folder of the project.
1819
3. To build the website, run `npm run build`.
@@ -21,36 +22,40 @@ Prerequisites: NodeJS must be installed on your machine.
2122
## Adding/Updating content
2223

2324
### How to add a bandhu
25+
2426
1. Create a new branch.
2527
2. Navigate to `content/team` folder.
2628
3. Create a new folder with the bandhu's first name in lowercase. Include the last name if there's another bandhu with the same first name.
2729
4. Create an index.md file inside the folder and the details like in the below template:
30+
2831
```
2932
---
30-
name:
33+
name:
3134
role:
32-
description:
35+
description:
3336
quote:
3437
medium:
3538
github:
36-
twitter:
39+
twitter:
3740
linkedin:
3841
behance:
3942
image: image.jpg
4043
sectors: Sector 1, Sector 2
4144
projects: Project 1, Project 2
4245
---
4346
```
47+
4448
5. If the description has more than one paragraph, add it is raw text below the metadata of the `index.md` file.
49+
4550
```
4651
---
47-
name:
52+
name:
4853
role:
49-
description:
54+
description:
5055
quote:
5156
medium:
5257
github:
53-
twitter:
58+
twitter:
5459
linkedin:
5560
behance:
5661
image: image.jpg
@@ -62,15 +67,17 @@ Paragraph 1 of the bandhu's description.
6267
6368
This is paragraph 2.
6469
```
70+
6571
6. Follow the same pattern for updating an existing bandhu's details.
6672
7. Create a pull request when you are done.
6773

68-
6974
### How to add a sector
75+
7076
1. Create a new branch.
7177
2. Navigate to `content/work/` folder.
7278
3. Create a new folder with the sector's name in lowercase and without spaces.
7379
4. Create an `index.md` file inside the folder and add the details like in the below template:
80+
7481
```
7582
---
7683
name:
@@ -95,15 +102,18 @@ events:
95102
---
96103
97104
```
105+
98106
5. The sector's image must be inside the same folder and its name should match what's written in the `index.md` file's metadata.
99107
6. To update an existing sector, simply edit the metadata of its `index.md` file.
100108
7. Create a pull request with your changes.
101109

102110
### How to add a project
111+
103112
1. Create a new branch.
104113
2. Navigate to `content/work/sectorone` folder, where `sectorone` is the name of the sector to which the project belongs.
105114
3. Create a new folder with the project's name in lowercase and without spaces.
106115
4. Create an `index.md` file inside the folder and add the details like in the below template:
116+
107117
```
108118
---
109119
name:
@@ -133,19 +143,27 @@ resources:
133143
---
134144
135145
```
146+
136147
5. The project's image must be inside the same folder and its name should match what's written in the `index.md` file's metadata.
137148
6. To update an existing project, simply edit the metadata of its `index.md` file.
138149
7. Create a pull request with your changes.
139150

140151
### How to add a job opening
152+
141153
1. Create a new branch.
142154
2. Navigate to `content/openings` folder.
143155
3. Create a markdown file with its name as the title of the job in lowercase.
144156
4. Add a url where the job post is listed and the proper title of the job inside the markdown file created in the previous step.
157+
145158
```
146159
---
147160
title: Front-end Engineer
148161
url: https://angel.co/company/civicdatalab/jobs/1279092-front-end-engineer
149162
---
150163
```
164+
151165
5. Create a pull request with the changes.
166+
167+
## License
168+
169+
The code is licensed under [MIT License](https://mit-license.org/) while the contents inside the `content` folder are licensed under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/).

src/components/Layout/Footer.js

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,10 @@ const SocialLinksContainer = styled.div`
152152
const SiteMap = styled.div`
153153
display: ${(props) => (props.mobile ? 'block' : 'none')};
154154
margin-top: 40px;
155+
a {
156+
color: white;
157+
text-decoration: none;
158+
}
155159
156160
@media (min-width: 1280px) {
157161
display: ${(props) => (props.mobile ? 'none' : 'block')};
@@ -211,7 +215,15 @@ const Footer = () => {
211215
<FaGithubAlt />
212216
</a>
213217
</SocialLinksContainer>
214-
<SiteMap>License | Site Map</SiteMap>
218+
<SiteMap>
219+
<a href="https://creativecommons.org/licenses/by/4.0/" target="_blank" rel="noreferrer noopener">
220+
License
221+
</a>
222+
{' '}|{' '}
223+
<a href="/sitemap/sitemap-0.xml" target="_blank">
224+
Site Map
225+
</a>
226+
</SiteMap>
215227
</ExternalLinksContainer>
216228
</AddressContainer>
217229
<NavigationContainer>

0 commit comments

Comments
 (0)