From d3adf87bf72cb4aa40a4bd13dbab82e3c0d98c91 Mon Sep 17 00:00:00 2001 From: Jaysa Maria Garcia <114126812+jaysa68@users.noreply.github.com> Date: Wed, 21 Jan 2026 22:00:05 -0800 Subject: [PATCH 1/3] bod notes guide (#30) --- docs/staff-docs/procedures/bod-notes.md | 28 +++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 docs/staff-docs/procedures/bod-notes.md diff --git a/docs/staff-docs/procedures/bod-notes.md b/docs/staff-docs/procedures/bod-notes.md new file mode 100644 index 0000000..46a54d7 --- /dev/null +++ b/docs/staff-docs/procedures/bod-notes.md @@ -0,0 +1,28 @@ +--- +title: How to Edit BoD Notes +--- + +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: + +## Github Web Editor + +1. Log into github and go to [github.com/ocf/mkdocs](https://github.com/ocf/mkdocs). +2. Under the name of the repository, open the branches dropdown (under the title of the repository) and then click "View All Branches. + - 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". + - If there is already a branch, select it in the dropdown. +3. Navigate to docs/bod/current_year/current_season. + - If you created a new branch, click "Add file" -> "Create new file" in the top right corner. + - Name the file YYYY-MM-DD.md + - Copy the contents from docs/bod/template into the new file. + - 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. +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! + + +## CLI + +1. `git clone git@github.com:ocf/mkdocs.git` +2. `git checkout -b YYYY-MM-DD-bod-notes` for a new branch or `git switch YYYY-MM-DD` for an existing one +3. `nvim mkdocs/docs/current_year/current_season/YYYY-MM-DD.md`, edit and save +4. `git add --all` +5. `git commit -m "update bod notes"` +6. `git push` From d5b556a012ed2964e15ce604b87342c646b6abb5 Mon Sep 17 00:00:00 2001 From: Jaysa Maria Garcia <114126812+jaysa68@users.noreply.github.com> Date: Wed, 21 Jan 2026 22:04:12 -0800 Subject: [PATCH 2/3] Update bod notes with branch sync instructions (#31) Add instructions for syncing branch with main branch. --- docs/staff-docs/procedures/bod-notes.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/staff-docs/procedures/bod-notes.md b/docs/staff-docs/procedures/bod-notes.md index 46a54d7..c9b8ce5 100644 --- a/docs/staff-docs/procedures/bod-notes.md +++ b/docs/staff-docs/procedures/bod-notes.md @@ -26,3 +26,7 @@ If you have something you want to talk about at BoD, you should note it down on 4. `git add --all` 5. `git commit -m "update bod notes"` 6. `git push` + +## My branch is out-of-sync with the main branch + +Do steps 1-2 of the CLI guide, then run `git pull`, `git rebase origin/main`, and `git push --force`. From c6a57379129cdcfc85e95b32eb1ee4c26234f558 Mon Sep 17 00:00:00 2001 From: Jaysa Maria Garcia <114126812+jaysa68@users.noreply.github.com> Date: Wed, 21 Jan 2026 22:12:35 -0800 Subject: [PATCH 3/3] Update BoD notes procedure with PR step Added a step for creating a pull request after committing changes. --- docs/staff-docs/procedures/bod-notes.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/staff-docs/procedures/bod-notes.md b/docs/staff-docs/procedures/bod-notes.md index c9b8ce5..258a3b4 100644 --- a/docs/staff-docs/procedures/bod-notes.md +++ b/docs/staff-docs/procedures/bod-notes.md @@ -15,8 +15,8 @@ If you have something you want to talk about at BoD, you should note it down on - Name the file YYYY-MM-DD.md - Copy the contents from docs/bod/template into the new file. - 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. -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! - +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". +5. Create a pull request and get it merged! ## CLI @@ -26,7 +26,9 @@ If you have something you want to talk about at BoD, you should note it down on 4. `git add --all` 5. `git commit -m "update bod notes"` 6. `git push` +7. Go create a PR for the branch on github, either using GitHub Cli or on the website. -## My branch is out-of-sync with the main branch +## FAQ +### My branch is out-of-sync with the main branch! Do steps 1-2 of the CLI guide, then run `git pull`, `git rebase origin/main`, and `git push --force`.