Skip to content

Commit fa02579

Browse files
authored
Update README.md
1 parent a468b67 commit fa02579

File tree

1 file changed

+0
-145
lines changed

1 file changed

+0
-145
lines changed

README.md

Lines changed: 0 additions & 145 deletions
Original file line numberDiff line numberDiff line change
@@ -19,151 +19,6 @@ Prerequisites: NodeJS must be installed on your machine.
1919
3. To build the website, run `npm run build`.
2020
4. To run the local build, run the following command: `npm run serve`.
2121

22-
## Adding/Updating content
23-
24-
### How to add a bandhu
25-
26-
1. Create a new branch.
27-
2. Navigate to `content/team` folder.
28-
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.
29-
4. Create an index.md file inside the folder and the details like in the below template:
30-
31-
```
32-
---
33-
name:
34-
role:
35-
description:
36-
quote:
37-
medium:
38-
github:
39-
twitter:
40-
linkedin:
41-
behance:
42-
image: image.jpg
43-
sectors: Sector 1, Sector 2
44-
projects: Project 1, Project 2
45-
---
46-
```
47-
48-
5. If the description has more than one paragraph, add it is raw text below the metadata of the `index.md` file.
49-
50-
```
51-
---
52-
name:
53-
role:
54-
description:
55-
quote:
56-
medium:
57-
github:
58-
twitter:
59-
linkedin:
60-
behance:
61-
image: image.jpg
62-
sectors: Sector 1, Sector 2
63-
projects: Project 1, Project 2
64-
---
65-
66-
Paragraph 1 of the bandhu's description.
67-
68-
This is paragraph 2.
69-
```
70-
71-
6. Follow the same pattern for updating an existing bandhu's details.
72-
7. Create a pull request when you are done.
73-
74-
### How to add a sector
75-
76-
1. Create a new branch.
77-
2. Navigate to `content/work/` folder.
78-
3. Create a new folder with the sector's name in lowercase and without spaces.
79-
4. Create an `index.md` file inside the folder and add the details like in the below template:
80-
81-
```
82-
---
83-
name:
84-
description:
85-
image: ./image.jpg
86-
color: '#FBC740'
87-
type: sector
88-
projects: Project 1, Project 2
89-
events:
90-
- {
91-
url: '',
92-
title: '',
93-
project: '',
94-
type: ''
95-
}
96-
- {
97-
url: '',
98-
title: '',
99-
project: '',
100-
type: ''
101-
}
102-
---
103-
104-
```
105-
106-
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.
107-
6. To update an existing sector, simply edit the metadata of its `index.md` file.
108-
7. Create a pull request with your changes.
109-
110-
### How to add a project
111-
112-
1. Create a new branch.
113-
2. Navigate to `content/work/sectorone` folder, where `sectorone` is the name of the sector to which the project belongs.
114-
3. Create a new folder with the project's name in lowercase and without spaces.
115-
4. Create an `index.md` file inside the folder and add the details like in the below template:
116-
117-
```
118-
---
119-
name:
120-
image: ./image.jpg
121-
summary: A 1-2 lines summary here.
122-
context:
123-
solution:
124-
aim:
125-
url:
126-
twitter:
127-
linkedin:
128-
github:
129-
newsletter:
130-
sector: Sector 1
131-
type: project
132-
resources:
133-
- {
134-
link: '',
135-
title: '',
136-
type: ''
137-
}
138-
- {
139-
link: '',
140-
title: '',
141-
type: ''
142-
}
143-
---
144-
145-
```
146-
147-
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.
148-
6. To update an existing project, simply edit the metadata of its `index.md` file.
149-
7. Create a pull request with your changes.
150-
151-
### How to add a job opening
152-
153-
1. Create a new branch.
154-
2. Navigate to `content/openings` folder.
155-
3. Create a markdown file with its name as the title of the job in lowercase.
156-
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-
158-
```
159-
---
160-
title: Front-end Engineer
161-
url: https://angel.co/company/civicdatalab/jobs/1279092-front-end-engineer
162-
---
163-
```
164-
165-
5. Create a pull request with the changes.
166-
16722
## License
16823

16924
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/).

0 commit comments

Comments
 (0)