Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
128 commits
Select commit Hold shift + click to select a range
5ee26e6
Added Untitled Diagram.drawio
braughtg Dec 20, 2025
73ed3f2
Delete materials/images/Untitled Diagram.drawio
braughtg Dec 20, 2025
4214691
Added BlankDiagram.drawio
braughtg Dec 20, 2025
a5a5c15
Create dir for ch-communities-and-collaboration text images.
braughtg Dec 20, 2025
1e862a2
Added basic-foss-workflow.drawio
braughtg Dec 20, 2025
578cdae
Delete materials/images/ch-communities-and-collaboration/text/dir
braughtg Dec 20, 2025
09d5936
Added basic-foss-workflow.png
braughtg Dec 20, 2025
8c6358e
Added basic-foss-workflow.drawio.png
braughtg Dec 20, 2025
d06d82f
Update basic-foss-workflow.drawio
braughtg Dec 20, 2025
fe538d9
Added basic-foss-workflow.png
braughtg Dec 20, 2025
983b7e0
Added basic-foss-workflow.drawio.png
braughtg Dec 20, 2025
0aacdc6
Added basic-foss-workflow.drawio.png
braughtg Dec 20, 2025
d436f5a
Update basic-foss-workflow.drawio
braughtg Dec 20, 2025
b0ba223
Delete materials/images/ch-communities-and-collaboration/text/basic-f…
braughtg Dec 20, 2025
815f975
Delete materials/images/ch-communities-and-collaboration/text/basic-f…
braughtg Dec 20, 2025
855231a
Added basic-foss-workflow.drawio.png
braughtg Dec 20, 2025
349b1aa
Update BlankDiagram.drawio
braughtg Dec 20, 2025
59a643b
Delete materials/images/ch-communities-and-collaboration/text/basic-f…
braughtg Dec 20, 2025
47bede8
Added basic-foss-workflow.drawio
braughtg Dec 20, 2025
7fcacfb
Update basic-foss-workflow.drawio
braughtg Dec 20, 2025
f9860be
Added basic-foss-workflow.drawio.png
braughtg Dec 20, 2025
6fc3465
Added basic-foss-workflow.png
braughtg Dec 20, 2025
bc32e53
Create README.md
braughtg Dec 20, 2025
55ec4c8
Delete materials/images/ch-communities-and-collaboration/text/basic-f…
braughtg Dec 20, 2025
abfb583
Delete materials/images/ch-communities-and-collaboration/text/basic-f…
braughtg Dec 20, 2025
a9264b4
Update BlankDiagram.drawio
braughtg Dec 29, 2025
55d7bea
Update BlankDiagram.drawio
braughtg Dec 29, 2025
20a9d42
Update BlankDiagram.drawio
braughtg Dec 29, 2025
bccaa81
Added BaseDiagram.drawio
braughtg Dec 29, 2025
b8aac65
Update BaseDiagram.drawio
braughtg Dec 29, 2025
ba417ed
Update BaseDiagram.drawio
braughtg Dec 29, 2025
516db67
Update BaseDiagram.drawio
braughtg Dec 30, 2025
7d27169
Update BaseDiagram.drawio
braughtg Dec 30, 2025
30f0659
Update BaseDiagram.drawio
braughtg Dec 31, 2025
8d251fe
Update BaseDiagram.drawio
braughtg Dec 31, 2025
8f282ba
Update README.md
braughtg Dec 31, 2025
909a1a7
Update BaseDiagram.drawio
braughtg Dec 31, 2025
30aba8d
Update BaseDiagram.drawio
braughtg Dec 31, 2025
2515c65
Update BaseDiagram.drawio
braughtg Dec 31, 2025
f5b5c94
Update BaseDiagram.drawio
braughtg Dec 31, 2025
c7b1446
Update BaseDiagram.drawio
braughtg Dec 31, 2025
50cd3e8
Update BaseDiagram.drawio
braughtg Dec 31, 2025
d176831
Update BaseDiagram.drawio
braughtg Jan 2, 2026
9ad6a4d
Update BaseDiagram.drawio
braughtg Jan 2, 2026
17b9df6
Added test.svg
braughtg Jan 2, 2026
4255c23
Update README.md
braughtg Jan 2, 2026
9e8a479
Update BaseDiagram.drawio
braughtg Jan 2, 2026
d056798
Update BaseDiagram.drawio
braughtg Jan 2, 2026
a371d24
Update README.md
braughtg Jan 2, 2026
638b229
Added BaseDiagram.svg
braughtg Jan 2, 2026
40b6a5c
Delete materials/images/BaseDiagram.drawio
braughtg Jan 2, 2026
7ec6510
Delete materials/images/test.svg
braughtg Jan 2, 2026
d73c83f
Added BlankDiagram.svg
braughtg Jan 2, 2026
094d458
Update BaseDiagram.svg
braughtg Jan 2, 2026
e74b3b5
Update BaseDiagram.svg
braughtg Jan 2, 2026
62657cd
Delete materials/images/BlankDiagram.drawio
braughtg Jan 2, 2026
13844c9
Update BaseDiagram.svg
braughtg Jan 2, 2026
f9130c0
Update BaseDiagram.svg
braughtg Jan 2, 2026
cafa24b
Update BaseDiagram.svg
braughtg Jan 2, 2026
ac985f5
Update BaseDiagram.svg
braughtg Jan 2, 2026
3f8c1bf
Update BaseDiagram.svg
braughtg Jan 2, 2026
2889d57
Update BaseDiagram.svg
braughtg Jan 2, 2026
d42a497
Update BaseDiagram.svg
braughtg Jan 2, 2026
3b5347d
Update BaseDiagram.svg
braughtg Jan 2, 2026
c4c685b
Update BaseDiagram.svg
braughtg Jan 2, 2026
e910c18
Update BaseDiagram.svg
braughtg Jan 2, 2026
d624731
Update BaseDiagram.svg
braughtg Jan 2, 2026
de98e3f
Update BaseDiagram.svg
braughtg Jan 2, 2026
36d6e25
Update BaseDiagram.svg
braughtg Jan 2, 2026
0e3b2ef
Update BaseDiagram.svg
braughtg Jan 2, 2026
d719e56
Update README.md
braughtg Jan 3, 2026
7740b11
Update README.md
braughtg Jan 3, 2026
f01feec
Update BaseDiagram.svg
braughtg Jan 3, 2026
a25a6a7
Update BaseDiagram.svg
braughtg Jan 3, 2026
13f5e5a
Create dir
braughtg Jan 3, 2026
e55248e
Delete materials/images/ch-communities-and-collaboration/slides/dir
braughtg Jan 3, 2026
bf7587d
Create blank.txt
braughtg Jan 3, 2026
58206fc
Create blank.txt
braughtg Jan 3, 2026
f3233e8
Create blank.txt
braughtg Jan 3, 2026
c72e2b8
Create blank.txt
braughtg Jan 3, 2026
4c0c00b
Delete materials/images/ch-upstreaming-changes/text/ch-upstreaming-ch…
braughtg Jan 3, 2026
b398155
Create blank.txt
braughtg Jan 3, 2026
40b98b6
Create blank.txt
braughtg Jan 3, 2026
362da5a
Create blank.txt
braughtg Jan 3, 2026
b3576fe
Create blank.txt
braughtg Jan 3, 2026
bfd372b
Update README.md
braughtg Jan 3, 2026
80f4515
Update README.md
braughtg Jan 3, 2026
ff8519c
Update BaseDiagram.svg
braughtg Jan 4, 2026
ff7e524
Update BaseDiagram.svg
braughtg Jan 4, 2026
a6c5339
Update BaseDiagram.svg
braughtg Jan 4, 2026
b75bf1e
Update BaseDiagram.svg
braughtg Jan 4, 2026
402d2a6
Update BaseDiagram.svg
braughtg Jan 4, 2026
95d1bbc
Update BaseDiagram.svg
braughtg Jan 4, 2026
545ba65
Update BaseDiagram.svg
braughtg Jan 4, 2026
93e2929
Update BaseDiagram.svg
braughtg Jan 4, 2026
5f746b5
Update BaseDiagram.svg
braughtg Jan 4, 2026
6161417
Update BaseDiagram.svg
braughtg Jan 4, 2026
f532aed
Update BaseDiagram.svg
braughtg Jan 4, 2026
69d6c07
Update README.md
braughtg Jan 4, 2026
1dbebeb
Update README.md
braughtg Jan 4, 2026
60d8626
restructured materials directory
braughtg Jan 4, 2026
75393fe
restructured materials directory
braughtg Jan 4, 2026
5ee4d4c
Update README.md
braughtg Jan 4, 2026
16a1e1c
Update BaseDiagram.svg
braughtg Jan 4, 2026
2c148d1
Added basic-foss-workflow.svg
braughtg Jan 4, 2026
3689f6e
Update basic-foss-workflow.svg
braughtg Jan 4, 2026
4268e72
Updates figure 2.6.1 - basic foss workflow
braughtg Jan 4, 2026
adbf9bc
deletes png for basic foss workflow diagram
braughtg Jan 4, 2026
3dc1269
update MC question for changes to the diagram
braughtg Jan 4, 2026
7036534
remove duplicate copy of BaseDiagram.svg
braughtg Jan 4, 2026
8a29497
Update README.md
braughtg Jan 4, 2026
20df38b
Update README.md
braughtg Jan 4, 2026
d82fc88
Update README.md
braughtg Jan 4, 2026
2f05997
Update BaseDiagram.svg
braughtg Jan 5, 2026
698d329
Update BaseDiagram.svg
braughtg Jan 5, 2026
88d955f
Update BaseDiagram.svg
braughtg Jan 5, 2026
5ade426
Update BaseDiagram.svg
braughtg Jan 5, 2026
5cd5bae
Update BaseDiagram.svg
braughtg Jan 5, 2026
0dc5a2f
Update BaseDiagram.svg
braughtg Jan 5, 2026
a46da6c
Update BaseDiagram.svg
braughtg Jan 5, 2026
f0cf65c
Update BaseDiagram.svg
braughtg Jan 6, 2026
719192d
Update BaseDiagram.svg
braughtg Jan 6, 2026
6409301
Added BentSwitchEx.svg
braughtg Jan 6, 2026
940ca52
Delete source/ch-communities-and-collaboration/images/BentSwitchEx.svg
braughtg Jan 6, 2026
a173e1f
Added BentSwitchEx.svg
braughtg Jan 6, 2026
fb4e9b7
Update BaseDiagram.svg
braughtg Jan 7, 2026
72ae913
Delete materials/BentSwitchEx.svg
braughtg Jan 7, 2026
9434de0
Update BaseDiagram.svg
braughtg Jan 7, 2026
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
28 changes: 21 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,31 @@ These are some helpful PreTeXt references:
## Overall Repository Structure

The files and folders in `source` include:

- `main.ptx`
- This file contains the outline for the whole book by importing other `.ptx` files.
- `ch-abc-def` folders
- Each chapter is contained in a folder.
- The file in the folder with the same name and the `.ptx` file is an outline of the chapter.
- This file gives some introductory text and then includes the `.ptx` files for the sections of the chapter.
- `sec-ghi-jkl.ptx`
- This file contains the markup and text for the section, subsections, exercises, etc.
- Section titles should be Title Case
- Use an “ing” word for sections that are actions tied to concepts (e.g. Forking the Upstream).
- This file gives some introductory text and then includes the `.ptx` files for the sections of the chapter.
- `sec-ghi-jkl.ptx`
- This file contains the markup and text for the section, subsections, exercises, etc.
- Section titles should be Title Case
- Use an “ing” word for sections that are actions tied to concepts (e.g. Forking the Upstream).
- `images`
- The `images` folder contains the images that appear in the chapter.
- Some images are stored directly in this folder.
- Others are symbolic links to files in `materials/images/<chapter>/text`.
- See `materials/images/README.md` for more details.
- The `assets/images/<chapter>` file is also a link to the `images` folder.

The files and folders in the `materials` directory include:
- `images` - a directory containing sub-directories for each chapter.
- `<chapter>` - a sub-directory for each chapter in the text.
- `text` - a sub-directory that contain many of the source images that appear in the chapter.
- These images are symlinked into the `source/<chapter>/images` directory.
- `slides` - a sub-directory taht contains many of the source images that appear in the slides.
- These images are manually incorporated into the slides.
- `slides` - a directory containing the PowerPoint slide decks.

## Terminology

Expand Down Expand Up @@ -314,4 +328,4 @@ Any of these versions can be built using "Build another target..." option on the
```text
pretext build web
pretext view web
```
```
4 changes: 4 additions & 0 deletions materials/BaseDiagram.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions materials/BlankDiagram.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
97 changes: 97 additions & 0 deletions materials/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
# Working with Images

## Draw.io

Images are SVG created and edited using [draw.io](https://www.drawio.com/).

## Structure

The `materials/` directory contains:
- `slides`: Directory containing the PowerPoint slide decks for each unit in the GitKit.
- `images/<chapter>`: A directory for each chapter of the text containing the images that appear in the slides for that chapter.
- `BaseDiagram.svg`: An image with all or nearly all of the elements necessary to produce all fo the Git/GitHub diagrams.
- `BlankDiagram.svg`: A blank image that is the same size as the `BaseDiagram.svg`.

The `source/<chapter>/images` directories contain the images that appear in the corresponding `<chapter>` of the text.

## The `BaseDiagram.svg` Image

The `BaseDiagram.svg` file contains an image with all or nearly all of the elements necessary to produce all fo the Git/GitHub diagrams.
- Additional diagrams are typically created by removing, editing, adapting elements of this diagram.
- This diagram is sized to match the size of the current images in the slides and text.
- The size is enforced by small invisible sqaure elements in each corner of the diagram.
- This enusres that when the images are exported they retain the proper size.
- It may be necessary to adapt this size by moving the invisible squares for some diagrams that are smaller or larger.
- Click in a corner and choose "Unlock" to be able to move the invisible square.

## Creating or Updating an Image

1. Log into GitHub with a user that has R/W permission to HFOSSedu.
2. Visit `HFOSSEdu/GitKit-Codespace` or your fork of it on GitHub.
3. Synchronize the `main` branch or the feature branch to which you are contributing with the upstream.
4. Browse the repository to identify the name and location of the image that you wish to start from:
- If creating a new image you might start from:
- The [`materials/BaseDiagram.svg`](./BaseDiagram.svg) or the [materials/BlankDiagram.svg`](./BlankDiagram.svg).
- An existing image in the text from the `<chapter>/images` sub-directories of [`source`](../source).
- An existing image in the slides from the `<chapter>` sub-directories of [`materials/images`](./images).
- If updating an existing image find its source:
- For images in the text look in the `<chapter>/images` sub-directories of [`source`](../source).
- For images in the slides look in the `<chapter>` sub-directories of [`materials/images`](./images).
5. Create a new feature branch from `main` or the feature branch to which you are contributing for your work.
6. Open the [Draw.io application](https://app.diagrams.net/).
7. Open the image you identified to start from:
- "File" -> "Open from" -> "GitHub".
- Choose the `HFOSSedu/GitKit-Codespace` or your fork of it.
- Select the feature branch that you created.
- Navigate to the image.
- Choose the `.svg` for the image that you identified.
8. If you are making a new image or replacing an existing image:
a. Make a copy of the image:
- "File" -> "Make a Copy..."
b. Rename the copy of the image:
- "File" -> "Rename..."
- If you are replacing an existing `.png` image rename the new image to match the filename of the image being replaced but using the extension `.svg` instead of `.png`.
- If you are creating an image sequence for the slide animations:
- Name the final image containing all elements `*.full.svg` where `*` is a descriptive name.
- Name the first image in the sequence `*.1.svg`, the second `*.2.svg`, and so forth.
c. Save the renamed image:
- "File" -> "Save as..."
- Verify the filename in the "Save as" box.
- Click the "Where" drop down and select "GitHub pick a folder"
- It may be necessary to "Authorize" Draw.io to commit to the GitHub repo as your user the first time you use it.
- Choose the feature branch you created for the new image.
- Choose the appropriate location for the new image:
- For images in the text save them in the approrpriate `<chapter>/images` sub-directory of `source`.
- For images in the slides save them in the appropraite `<chapter>` sub-directory of `materials/images`.
- Click "Save".
9. Edit the image and save as necessary.

Note: When working on an image and saving on-going changes, Draw.io often reports an "Error saving file" due to a "Timeout". Saving again will often resolve the issue but you will be propted to "Merge" or "Overwrite" the existing file. Choose the "Overwrite" option to commit the current version of the file.

## Updating an Image in the Text

1. Open a codespace on `GitKit-Codespaces` from the repository where you have your feature branch.
2. Ensure that you are on your feature branch.
3. Open the PreTeXT source file that references the image from the `source/<chapter>` directory.
4. Change the reference to the image to point to the linked `.svg` file instead of to the `.png` file.
5. Update any captions, text or exercises that reference the diagram as necessary.
6. Rebuild text and verify that the image and any new captions/text/exercises appear correctly.
- If a `.png` image was replaced by a `.svg` image delete the `.png` image file from the `source/<chapter>/images` directory.
7. Stage and commit the changes.
8. Create a pull request to the upstream repository.
- If you are working on a specific issue in the issue tracker, check its description to see if the PR should be made to the main branch or to a feature branch that is being used to collect a number of related changes before being merged into main.

## Updating an Image or Image Sequence in the Slides

1. Ensure that:
- All open PR's for changes to the same slide deck have been merged into the `draw.io-images` branch.
- No one else is currently working on a PR for the same slide deck.
3. Clone the `GitKit-Codespace` repo containing your feature branch to your local machine.
- Or update with `git pull upstream draw.io-images`
4. Ensure that you are on your feature branch.
5. Open the slide deck to be updated.
6. Replace the image(s) in the slides with the SVG image(s).
7. Save the slide deck.
8. Stage and commit the changes.
9. Create a pull request to the upstream repository.
- If you are working on a specific issue in the issue tracker, check its description to see if the PR should be made to the main branch or to a feature branch that is being used to collect a number of related changes before being merged into main.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

1 change: 1 addition & 0 deletions materials/images/ch-merge-conflicts/placeholder.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

1 change: 1 addition & 0 deletions materials/images/ch-staying-synchronized/placeholder.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

1 change: 1 addition & 0 deletions materials/images/ch-upstreaming-changes/placeholder.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<p>
<figure xml:id="fig-basic-foss-workflow" label="fig-basic-foss-workflow" >
<caption> A basic FOSS workflow. </caption>
<image source="images/ch-communities-and-collaboration/basic-foss-workflow.png" width="75%">
<image source="images/ch-communities-and-collaboration/basic-foss-workflow.svg" width="75%">
<shortdescription>
Diagram showing the relationships between the main repo, your remote copy, and your local copy.
</shortdescription>
Expand Down Expand Up @@ -44,7 +44,7 @@
</p>
</statement>

<matches> <match> <premise>Upstream</premise> <response>Main project repository</response> </match> <match> <premise>Origin</premise> <response>Your Remote Copy</response> </match> <match> <premise>Local Clone</premise> <response>Local Copy of Your Remote Copy</response> </match> </matches>
<matches> <match> <premise>Upstream</premise> <response>The main project repository</response> </match> <match> <premise>Origin or Fork</premise> <response>Your remote copy of the main project repository.</response> </match> <match> <premise>Local or Clone</premise> <response>Your local copy of your remote copy.</response> </match> </matches>
<hint>
<p>
Review the diagrams of the basic FOSS workflow from the in the class materials.
Expand Down