Skip to content

Commit 538bace

Browse files
committed
✔️ Address @10eMyrT's feedback in PR #30
Reorganize structure to move meta information about how the site works to the "About" section. Makes "How to add content" section easier to follow. Signed-off-by: Justin W. Flory <[email protected]>
1 parent b4a2131 commit 538bace

File tree

1 file changed

+35
-33
lines changed

1 file changed

+35
-33
lines changed

docs/infra/website.md

Lines changed: 35 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -15,41 +15,10 @@ The website source code is found in [FOSSRIT/fossrit.github.io](https://github.c
1515

1616
_The site uses an undocumented feature of Jekyll where categories are defined using `category/_posts/` instead of `_posts/category/`._
1717

18-
19-
## How to update FOSS Hours time/place
20-
21-
Edit [`_config.yml`](https://github.com/FOSSRIT/fossrit.github.io/blob/master/_config.yml) and update the settings `meeting-day`, `meeting-place`, and `meeting-time`.
22-
These settings are used across the website automatically.
23-
The meeting time and place are referenced in the `_config.yml` so they are updated in one place.
24-
25-
Example:
26-
27-
```yaml
28-
# --- meeting schedule settings ---
29-
30-
# They appear exactly as typed. Follow the format already here when updating.
31-
meeting-day: Thursday
32-
meeting-place: MSS/71-3190 (conference room)
33-
meeting-time: 5:00PM - 7:00PM
34-
```
35-
36-
37-
## How to add content
38-
39-
This section describes how to add new content to the FOSS@MAGIC website.
40-
41-
Add a new `.md` file to one of the `_posts/` folders for a category.
42-
Store assets (a.k.a. pictures, PDFs, or other downloadable files) in a folder within that category (e.g. `projects/assets/`).
43-
Include the date in asset file names so it is clear what references it.
44-
45-
Content categories include the following:
46-
47-
* [Announcements](https://github.com/FOSSRIT/fossrit.github.io/tree/master/announcements)
48-
* [Events](https://github.com/FOSSRIT/fossrit.github.io/tree/master/events)
49-
* [Projects](https://github.com/FOSSRIT/fossrit.github.io/tree/master/projects)
50-
5118
### Git work flow
5219

20+
This describes how to make any type of contribution to the FOSS@MAGIC website:
21+
5322
1. Fork repository to your GitHub account (go to [FOSSRIT/fossrit.github.io](https://github.com/FOSSRIT/fossrit.github.io) and click "fork")
5423
2. Clone repository locally to your workstation
5524
3. Create/add files
@@ -93,6 +62,39 @@ Other things happening.
9362
- Signature
9463
```
9564
65+
66+
## How to update FOSS Hours time/place
67+
68+
Edit [`_config.yml`](https://github.com/FOSSRIT/fossrit.github.io/blob/master/_config.yml) and update the settings `meeting-day`, `meeting-place`, and `meeting-time`.
69+
These settings are used across the website automatically.
70+
The meeting time and place are referenced in the `_config.yml` so they are updated in one place.
71+
72+
Example:
73+
74+
```yaml
75+
# --- meeting schedule settings ---
76+
77+
# They appear exactly as typed. Follow the format already here when updating.
78+
meeting-day: Thursday
79+
meeting-place: MSS/71-3190 (conference room)
80+
meeting-time: 5:00PM - 7:00PM
81+
```
82+
83+
84+
## How to add content
85+
86+
This section describes how to add new content to the FOSS@MAGIC website.
87+
88+
Add a new `.md` file to one of the `_posts/` folders for a category.
89+
Store assets (a.k.a. pictures, PDFs, or other downloadable files) in a folder within that category (e.g. `projects/assets/`).
90+
Include the date in asset file names so it is clear what references it.
91+
92+
Content categories include the following:
93+
94+
* [Announcements](https://github.com/FOSSRIT/fossrit.github.io/tree/master/announcements)
95+
* [Events](https://github.com/FOSSRIT/fossrit.github.io/tree/master/events)
96+
* [Projects](https://github.com/FOSSRIT/fossrit.github.io/tree/master/projects)
97+
9698
### How to create announcements
9799

98100
Announcements spread the word about what is happening in the community.

0 commit comments

Comments
 (0)