Memo-documentation training
#temporary #training #meeting #git #vcs #codeberg #jjvcs
Authors:
- Josh T.
Date of meeting: On Saturday 2026-05-02 Time of meeting: 1200 to 1430
I want to use this meeting to setup and train team members on the software necessary to update our documentation.
I want to run this as a workshop where I help people get setup after they have already attempted to do so on their own the week prior. More troubleshooting than lecture.
Anyone who's already setup by this date can skip or work on another project. We will probably need to do this again later as well.
1 What you need to bring
- A laptop if you have one
- Even if you don't you should still attend if you aren't setup because we can do some things on the desktops in the Engineering computer room.
- Assuming you are running Windows:
- Install putty.
- If if the installer gives you the option to install "Pageant" and "putty gen" do that as well.
- Install putty.
- For all OSs:
- Install Obsidian
- Install one of these code editors:
- Notepad ++
- VSCodium
- If you already have a preference use that.
- Install JJ-vcs (Jujutsu).
- Optional: install Nushell to mimic my setup.
- Create a Codeberg account.
If you don't know what a "terminal" or "command line" is, wait for the in person meeting before moving on, or ask a teammate who knows for in-person help.
2 If you want to get a head start
- Make a Create a Fork of this repository on Codeberg.
- Create an SSH key using Putty on Windows
- If you're not on Windows you can figure it out or ask me.
- Use "ED25519" type keys!
- Add your SSH key to your Codeberg account.
- Setup JJ on your computer
- Optional but Recommended setup the Pageant SSH agent
- Install JJ
- Setup JJ for use with online repositories.
- Set your
EDITORenvironment variable to the.exefile for the code editor you chose.
- Install Obsidian.
- Clone your Fork of this repository to your local machine (See: S9-Pull_Request_Process).
- This can be done with git, jj-vcs, or the Obsidian Git plugin.
- STOP! Don't go further than here without checking in!
3 To Do
We need guides for:
- Using Obsidian
- Procedure for making sure commit messages are done correctly.
- Guide and cheat-sheet for JJ-VCS
The Git related stuff can go in one doc and Obsidian can go in another.
4 Delete when
Delete this after the meeting, and after he above JJ and Obsidian Guides are created.