-
Notifications
You must be signed in to change notification settings - Fork 1
/
instructions.mbd
87 lines (61 loc) · 4 KB
/
instructions.mbd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
<frontmatter>
title: Updating this website
header: pagetop.md
pageNav: 2
</frontmatter>
# Instructions for Updating this Website
This repo/website is for hosting information about the students in the module, to be maintained by CS3281&2 students collectively. %%It is maintained as a separate repo because students need write access to it.%%
## General Instructions for Updating This Repo
* Clone https://github.com/nus-cs3281/{{ year }} to your Computer.
* Do not force-push.
* Usually, there is no need to create issues or PRs when updating this repo.
While this site uses [MarkBind](https://markbind.github.io/markbind/), you can use normal markdown syntax for your updates (MarkBind is compatible with Markdown).
All your files are in a `students/*` sub-folder that is named after you e.g., `students/johnDoe`. Update the `info.md` file in that folder with your basic info. After you have pushed the updated files to the repo, your info should appear automatically in [this page]({{ baseUrl }}/), possibly after a lapse of a few minutes.
If you want to preview the generated site for your changes, there are two options:
1. Install MarkBind, use the `markbind serve` command to generate the site locally, and ensure the output is as you intended.
2. Create a PR, and use the Netlify PR preview to check how the PR updates the website.
## Updating Your Basic Info
* Update a profile photo named `photo.png` to your folder. %%Naturally, as the purpose of this photo is for others to identify you, you should choose a recent individual photo showing your face clearly (i.e., not too small) -- somewhat similar to a passport photo.%%
* Update other info in the `info.md` file in your folder.
## Adding the Resume
* Update the `resume.md` in your folder.
* Length 1-2 pages.
* ==Don't simply copy-paste your current resume.== Customize it to fit the module requirements. Recommended sections to have:
* Credentials: A brief segment covering highlights of education qualifications, awards, grades, etc.
* Experience: List work experience but do not give too much details. Just where, when, in what role, and possibly 1-2 line about what you did there.
* Competencies: give 2-3 things you are good at. For each, give concrete evidence to back up your claims. Give links to your work when you can. Cross refer previous section when necessary.
* {{ icon_important_red }} Do not give a long laundry list of technologies/tools.
<panel type="seamless" header="%%Why use markdown instead of PDF etc.?%%">
We require a text-based resume so that we can track the changes to it during the semester. Also, you should also have (even _prefer_) a text-based resume because some big companies (and head-hunting agencies) use text bots to process resumes.
</panel>
## Updating Your Project Progress
Update the `progress.md` in your folder periodically, at least once every two weeks.
<tabs>
<tab header="Sample">
Week | Achievements
---- | ------------
1 | Reviewed PR: [PR name 1 #1234]()
1 | Merged PR: [PR name 4 #3245]()
2 | Submitted Issue: [Issue name #223]()
2 | Authored PR (put on hold by request): [PR name 3 #365]()
2 | Responded to contributor queries: [#1234](), [#4567]()
</tab>
<tab header="Code for the sample">
```
Week | Achievements
---- | ------------
1 | Reviewed PR: [PR name 1 #1234]()
1 | Merged PR: [PR name 4 #3245]()
2 | Submitted Issue: [Issue name #223]()
2 | Authored PR (put on hold by request): [PR name 3 #365]()
2 | Responded to contributor queries: [#1234](), [#4567]()
```
</tab>
</tabs>
Notes:
* The page is for CS3282 work only (i.e., contributions to our own internal projects)
* PR-related contributions: Report only when a PR is merged (or it's finalized in some other way e.g., abandoned)
* Past PRs can be claimed in future weeks, but not the other way around.
* Report each significant achievement in a separate row. You may aggregate multiple minor achievements in to a single row.
## Updating the Process Observations Page
Update the `observations.md` page in your folder with your observations from the external projects.