Skip to content

Commit d3adf87

Browse files
authored
bod notes guide (#30)
1 parent 4160301 commit d3adf87

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: How to Edit BoD Notes
3+
---
4+
5+
If you have something you want to talk about at BoD, you should note it down on the BoD Notes before the meeting! Here's how to do it:
6+
7+
## Github Web Editor
8+
9+
1. Log into github and go to [github.com/ocf/mkdocs](https://github.com/ocf/mkdocs).
10+
2. Under the name of the repository, open the branches dropdown (under the title of the repository) and then click "View All Branches.
11+
- If a branch containing the date of the upcoming bod does not yet exist, click "New Branch" and name the new branch "YYYY-MM-DD-bod-notes", then click "Create new branch".
12+
- If there is already a branch, select it in the dropdown.
13+
3. Navigate to docs/bod/current_year/current_season.
14+
- If you created a new branch, click "Add file" -> "Create new file" in the top right corner.
15+
- Name the file YYYY-MM-DD.md
16+
- Copy the contents from docs/bod/template into the new file.
17+
- If you're editing the BoD notes on an existing branch, there should already be a file named YYYY-MM-DD.md for you to select. Then, click the pencil icon in the top right corner.
18+
4. Make your additions to the file, then click "Commit changes...", add a short commit message ("add topic to bod notes" is fine), and click "Commit changes". And you're done!
19+
20+
21+
## CLI
22+
23+
1. `git clone git@github.com:ocf/mkdocs.git`
24+
2. `git checkout -b YYYY-MM-DD-bod-notes` for a new branch or `git switch YYYY-MM-DD` for an existing one
25+
3. `nvim mkdocs/docs/current_year/current_season/YYYY-MM-DD.md`, edit and save
26+
4. `git add --all`
27+
5. `git commit -m "update bod notes"`
28+
6. `git push`

0 commit comments

Comments
 (0)