diff --git a/README.md b/README.md index 0c7f124..a13a919 100644 --- a/README.md +++ b/README.md @@ -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//text`. + - See `materials/images/README.md` for more details. + - The `assets/images/` 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. + - `` - 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//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 @@ -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 -``` \ No newline at end of file +``` diff --git a/materials/BaseDiagram.svg b/materials/BaseDiagram.svg new file mode 100644 index 0000000..6094faf --- /dev/null +++ b/materials/BaseDiagram.svg @@ -0,0 +1,4 @@ + + + +
Clone/Local
Clone/Local
C
C
D
D
B
B
F
F
E
E
DE
DE
A
A
commit
commit
DE
DE
Stage
Stage
switch
switch
Fork/Origin
Fork/Origin
Upstream
Upstream
Pull Request
Pull Req...
Fork
Fork
clone
clone
push
push
Working Directory
Working Directory
DE
DE
stage
stage
pull
pull
Local (git / CLI / IDE)
Local (git / CLI /...
Remote (GitHub)
Remote (GitHub)
C
C
D
D
B
B
F
F
E
E
DE
DE
A
A
C
C
D
D
B
B
DE
DE
A
A
main branch
main branch
feature branch
feature branchText is not SVG - cannot display \ No newline at end of file diff --git a/materials/BlankDiagram.svg b/materials/BlankDiagram.svg new file mode 100644 index 0000000..55963ae --- /dev/null +++ b/materials/BlankDiagram.svg @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/materials/README.md b/materials/README.md new file mode 100644 index 0000000..2c9d9c2 --- /dev/null +++ b/materials/README.md @@ -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/`: 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//images` directories contain the images that appear in the corresponding `` 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 `/images` sub-directories of [`source`](../source). + - An existing image in the slides from the `` sub-directories of [`materials/images`](./images). + - If updating an existing image find its source: + - For images in the text look in the `/images` sub-directories of [`source`](../source). + - For images in the slides look in the `` 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 `/images` sub-directory of `source`. + - For images in the slides save them in the appropraite `` 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/` 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//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. diff --git a/materials/images/ch-communities-and-collaboration/placeholder.txt b/materials/images/ch-communities-and-collaboration/placeholder.txt new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/materials/images/ch-communities-and-collaboration/placeholder.txt @@ -0,0 +1 @@ + diff --git a/materials/images/ch-merge-conflicts/placeholder.txt b/materials/images/ch-merge-conflicts/placeholder.txt new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/materials/images/ch-merge-conflicts/placeholder.txt @@ -0,0 +1 @@ + diff --git a/materials/images/ch-staying-synchronized/placeholder.txt b/materials/images/ch-staying-synchronized/placeholder.txt new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/materials/images/ch-staying-synchronized/placeholder.txt @@ -0,0 +1 @@ + diff --git a/materials/images/ch-upstreaming-changes/placeholder.txt b/materials/images/ch-upstreaming-changes/placeholder.txt new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/materials/images/ch-upstreaming-changes/placeholder.txt @@ -0,0 +1 @@ + diff --git a/source/ch-communities-and-collaboration/images/basic-foss-workflow.png b/source/ch-communities-and-collaboration/images/basic-foss-workflow.png deleted file mode 100644 index 5e9f3a6..0000000 Binary files a/source/ch-communities-and-collaboration/images/basic-foss-workflow.png and /dev/null differ diff --git a/source/ch-communities-and-collaboration/images/basic-foss-workflow.svg b/source/ch-communities-and-collaboration/images/basic-foss-workflow.svg new file mode 100644 index 0000000..bbd1a91 --- /dev/null +++ b/source/ch-communities-and-collaboration/images/basic-foss-workflow.svg @@ -0,0 +1,4 @@ + + + +
Clone/Local
Clone/Local
Local Copy
of Your
Remote Copy
Local Copy...
Fork/Origin
Fork/Origin
Upstream
Upstream
pull request
pull re...
fork
fork
clone
clone
push
push
Local (git / CLI / IDE)
Local (git / CLI /...
Remote (GitHub)
Remote (GitHub)
Main Project
Repository
Main Project...
Your Remote
Copy
Your Remote...Text is not SVG - cannot display \ No newline at end of file diff --git a/source/ch-communities-and-collaboration/sec-basic-foss-workflow.ptx b/source/ch-communities-and-collaboration/sec-basic-foss-workflow.ptx index a010fad..6f34c98 100644 --- a/source/ch-communities-and-collaboration/sec-basic-foss-workflow.ptx +++ b/source/ch-communities-and-collaboration/sec-basic-foss-workflow.ptx @@ -13,7 +13,7 @@

A basic FOSS workflow. - + Diagram showing the relationships between the main repo, your remote copy, and your local copy. @@ -44,7 +44,7 @@

- Upstream Main project repository Origin Your Remote Copy Local Clone Local Copy of Your Remote Copy + Upstream The main project repository Origin or Fork Your remote copy of the main project repository. Local or Clone Your local copy of your remote copy.

Review the diagrams of the basic FOSS workflow from the in the class materials.