Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add faq contribution guide #528

Merged
merged 4 commits into from
Oct 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions content/resources/contribution-guides/contributing-faqs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Contributing FAQs

FAQs can be be viewed here - [ccss.carleton.ca/faq/course-registration/](https://ccss.carleton.ca/faq/course-registration/)

FAQ Topic Page:
<img src="/static/images/resources/faqs/faq-page.png"/>

Sample FAQ:
<img src="/static/images/resources/faqs/sample-faq.png"/>

<br/>

## 0.1 Setup the CCSS website project locally

Follow the instructions in the **README**

## 0.2 Look at the example for a written FAQ

The markdown file for a completed FAQ can be found here: `content/resources/faq/questions/free-vs-breadth-electives.md`
Sample completed FAQ page - [What is a Breadth elective vs a Free elective](https://ccss.carleton.ca/resources/faq/questions/free-vs-breadth-electives/)

## 1. Pick an unwritten FAQ from the project board

[Resources Contributions Project Board](https://github.com/orgs/CarletonComputerScienceSociety/projects/22)

## 2. Locate the empty markdown file

You can find the FAQ markdown files here: `content/resources/faq/questions`

## 3. Complete the front matter attributes

- `title` - The title of the FAQ that will show up on the webpage
- `date` - The date on which an FAQ was initially published. Format - `YYYY-MM-DDT00:00:00Z`
- `last_updated` - If an FAQ is updated, the date of the edit. Otherwise, same as the `date` attribute. Format - `YYYY-MM-DDT00:00:00Z`
- `draft` - Value should be set to "true"
- `layout` - Value should be set to "faq-question""
- `summary` - Summary text that will show up on the topic page with the full list of FAQs (see first image)
- `contributors` - Names of the people that contributed to writing and editing the FAQ
- `sources`: Any links or sources that have been referenced in the answer. Format:
```diff
- name1: Title of the webpage
link1: Link
- name2: Title of the webpage
link2: Link
...
```

## 4. Write the answer

- FAQs are intended to summarise relevant information as concisely as possible. Try to stick to **100-200 words**.
- Don't rewrite things that have already been explained by the School of Computer Science or Carleton University webpages. You can include a short summary or quote and then link to their webpages.
- The ticket on the project board corresponding to your FAQ will highlight some information that should be covered by your answer.

## 5. Format your answer with markdown

If you are not familiar with markdown, check out [Github's guide for markdown syntax](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)

You can refer to a completed FAQ file to get an idea of how to include links

## 6. Make a Pull Request with the completed FAQ file

If you are not familiar with using Git/Github, check out this guide - [Intro to Git and Github](https://product.hubspot.com/blog/git-and-github-tutorial-for-beginners)


Binary file added static/images/resources/faqs/faq-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/resources/faqs/sample-faq.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading