From 56e5f45dab02cd28d951ff3719ae3d77e6e26ad1 Mon Sep 17 00:00:00 2001 From: Grant Braught Date: Mon, 13 Jan 2025 18:46:28 +0000 Subject: [PATCH 01/39] simplifies publication targets for single edition --- .devcontainer.json | 4 +- .github/workflows/pretext-cli.yml | 15 +- project.ptx | 23 +-- ...dent-linux.ptx => publication-example.ptx} | 7 +- publication/publication-instructor-linux.ptx | 141 ------------------ publication/publication-instructor-vscode.ptx | 141 ------------------ publication/publication-linux.ptx | 140 ----------------- publication/publication-runestone-vscode.ptx | 125 ---------------- ...ne-linux.ptx => publication-runestone.ptx} | 1 - publication/publication-student-vscode.ptx | 141 ------------------ publication/publication-vscode.ptx | 140 ----------------- publication/publication.ptx | 6 +- 12 files changed, 25 insertions(+), 859 deletions(-) rename publication/{publication-student-linux.ptx => publication-example.ptx} (97%) delete mode 100644 publication/publication-instructor-linux.ptx delete mode 100644 publication/publication-instructor-vscode.ptx delete mode 100644 publication/publication-linux.ptx delete mode 100644 publication/publication-runestone-vscode.ptx rename publication/{publication-runestone-linux.ptx => publication-runestone.ptx} (99%) delete mode 100644 publication/publication-student-vscode.ptx delete mode 100644 publication/publication-vscode.ptx diff --git a/.devcontainer.json b/.devcontainer.json index 732ab66..7da7a9c 100644 --- a/.devcontainer.json +++ b/.devcontainer.json @@ -15,9 +15,9 @@ "name": "PreTeXt-Codespaces", // This Docker image includes some LaTeX support, but is still not to large. Note that if you keep your codespace running, it will use up your GitHub free storage quota. Additional options are listed below. - "image": "oscarlevin/pretext:small", + // "image": "oscarlevin/pretext:small", // If you need to generate more complicated assets (such as sageplots) or use additional fonts when building to PDF, comment out the above line and uncomment the following line. - // "image": "oscarlevin/pretext:full", + "image": "oscarlevin/pretext:full", // If you only intend to build for web and don't have any latex-image generated assets, you can use a smaller image: // "image": "oscarlevin/pretext:lite", diff --git a/.github/workflows/pretext-cli.yml b/.github/workflows/pretext-cli.yml index 22b8a3c..2be6660 100644 --- a/.github/workflows/pretext-cli.yml +++ b/.github/workflows/pretext-cli.yml @@ -24,8 +24,21 @@ jobs: - name: install deps run: pip install -r requirements.txt + - name: install local ptx files + run: pretext --version + - name: build deploy targets - run: pretext build --deploys + run: | + version="$(pretext --version)" + major="$(echo $version | cut -d '.' -f 1)" + minor="$(echo $version | cut -d '.' -f 2)" + if [ "$major" -ge 2 -a "$minor" -ge 5 ]; then + echo "PreTeXt version is 2.5 or greater; using new build command" + pretext build --deploys + else + echo "PreTeXt version is less than 2.5, using old build command" + pretext build + fi - name: stage deployment run: pretext deploy --stage-only diff --git a/project.ptx b/project.ptx index a930d8c..3f2fabc 100644 --- a/project.ptx +++ b/project.ptx @@ -2,27 +2,10 @@ - - + + - - - - - - - - - - - - - - - + diff --git a/publication/publication-student-linux.ptx b/publication/publication-example.ptx similarity index 97% rename from publication/publication-student-linux.ptx rename to publication/publication-example.ptx index fe0593b..913a4e4 100644 --- a/publication/publication-student-linux.ptx +++ b/publication/publication-example.ptx @@ -21,7 +21,7 @@ - + @@ -34,7 +34,6 @@ - @@ -61,7 +60,7 @@ - + @@ -70,7 +69,7 @@ - + diff --git a/publication/publication-instructor-linux.ptx b/publication/publication-instructor-linux.ptx deleted file mode 100644 index f07770e..0000000 --- a/publication/publication-instructor-linux.ptx +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/publication/publication-instructor-vscode.ptx b/publication/publication-instructor-vscode.ptx deleted file mode 100644 index 4b85f3e..0000000 --- a/publication/publication-instructor-vscode.ptx +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/publication/publication-linux.ptx b/publication/publication-linux.ptx deleted file mode 100644 index 6e00d3c..0000000 --- a/publication/publication-linux.ptx +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/publication/publication-runestone-vscode.ptx b/publication/publication-runestone-vscode.ptx deleted file mode 100644 index 7ff25c8..0000000 --- a/publication/publication-runestone-vscode.ptx +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/publication/publication-runestone-linux.ptx b/publication/publication-runestone.ptx similarity index 99% rename from publication/publication-runestone-linux.ptx rename to publication/publication-runestone.ptx index f8600a2..c84a189 100644 --- a/publication/publication-runestone-linux.ptx +++ b/publication/publication-runestone.ptx @@ -34,7 +34,6 @@ - diff --git a/publication/publication-student-vscode.ptx b/publication/publication-student-vscode.ptx deleted file mode 100644 index e2c843d..0000000 --- a/publication/publication-student-vscode.ptx +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/publication/publication-vscode.ptx b/publication/publication-vscode.ptx deleted file mode 100644 index d6aaf27..0000000 --- a/publication/publication-vscode.ptx +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/publication/publication.ptx b/publication/publication.ptx index 913a4e4..3c36c6b 100644 --- a/publication/publication.ptx +++ b/publication/publication.ptx @@ -21,7 +21,7 @@ - + @@ -60,7 +60,7 @@ - + @@ -69,7 +69,7 @@ - + From 325c3e1cc113400bb6517a87c487ec2773bf42cb Mon Sep 17 00:00:00 2001 From: Grant Braught Date: Mon, 13 Jan 2025 21:31:10 +0000 Subject: [PATCH 02/39] removes all component attributes, and vscode KitClient content --- .../sec-cloning-your-origin.ptx | 43 +----- .../sec-development-environment.ptx | 131 +----------------- .../sec-extra-practice.ptx | 22 +-- .../sec-instructor-communities.ptx | 5 +- .../sec-instructor-intro.ptx | 32 +---- .../sec-instructor-synchronization.ptx | 5 +- .../sec-verifying-the-upstream-remote.ptx | 103 ++------------ .../sec-pushing-a-branch-to-your-origin.ptx | 51 +------ source/docinfo.ptx | 2 +- source/main.ptx | 2 +- 10 files changed, 34 insertions(+), 362 deletions(-) diff --git a/source/ch-communities-and-collaboration/sec-cloning-your-origin.ptx b/source/ch-communities-and-collaboration/sec-cloning-your-origin.ptx index 173309f..2126381 100644 --- a/source/ch-communities-and-collaboration/sec-cloning-your-origin.ptx +++ b/source/ch-communities-and-collaboration/sec-cloning-your-origin.ptx @@ -24,13 +24,6 @@

- -

- In some development environments cloning the origin requires that you use a command like git clone <originURL>.git to create the clone. -

-

- However, the development environment you have opened in GitPod simplifies this process for you. Recall, that you provided the URL of your origin repository when opening the development environment in . When you did that, a clone of your origin was automatically created for you in your development environment. -

@@ -39,8 +32,7 @@ + label="ex-find-clone-url-linux"> In order to clone a repository into your development environment you will need the clone URL for that repository. The steps in this exercise will help you find the clone URL for your origin repository. @@ -96,8 +88,7 @@ + label="ex-clone-url-linux">

Copy and paste the clone URL that you will use to clone your origin as your answer to this exercise. @@ -146,8 +137,7 @@ + label="ex-clone-origin-linux">

Now that you have the clone URL for your origin repository, use the tasks in this exercise to clone your origin into your development environment. @@ -205,8 +195,7 @@ + label="ex-kit-tty-linux">

The the output in should contain a message from the Kit-tty. What is the Kit-tty? @@ -221,14 +210,13 @@ -

+

Be sure to keep your eyes open for messages from the Kit-tty as you work on the GitKit exercises. The Kit-tty will help you to stay on track and may save you a lot of time by preventing you from going down an incorrect path.

+ label="ex-close-terminal-linux">

Use the final line of output in that begins with "IMPORTANT" to complete this exercise. @@ -294,8 +282,7 @@ + label="ex-explore-clone-linux">

In this exercise you will briefly explore the GitKit FarmData2 repository that you have cloned into your development environment. @@ -330,22 +317,6 @@ - - - -

- The development environment displays the files and directories contained in your clone in the "Explorer" panel at the left of the window. You can also see a list of these files and directories by using the ls -a command in the Terminal. -

-

- Compare these files and directories to those in your origin repository on GitHub. Are there any differences? If so describe them here. -

- - - - + label="ex-create-kit-client">

The following tasks will guide you through the process of starting and configuring your development environment. @@ -135,8 +134,7 @@ + label="ex-configure-kit-client-linux">

There are a few additional things that you can to to make working in your development environment more convenient. @@ -178,110 +176,6 @@ - - - - -

- The following tasks will guide you through the process of starting and configuring your development environment. -

- - - - -

- Click this link to - Launch KitClient in GitPod. -

- - - - - -

- Paste the URL of your GitKit FarmData2 repository from into the text box and press "Enter". -

- - - - - -

- Choose "VS Code..." as the "Editor - Browser" and "Standard" as the machine "Class" as shown here: - - - - Creating the development environment in GitPod. - - -

- - - - - -

- Click the "Continue" button and wait for the development environment to open in the browser. It will appear similar to the window shown in . -

-

-

- - The development environment. - - - - The development environment window showing the VS Code interface. - - -
-

- - - - - -

- A message box may appear in the lower right corner of the development environment asking if you would like to reopen the project in "VS Code Desktop". If this happens you can click the "X" to close the box, or ignore it and it will go away on its own. -

- - - - - - -

- In the "TERMINAL" tab at the bottom of the window you should see "😺💻 Meow, Kit-tty here!" in the output. Read the associated text. - - What is the Kit-tty? -

- - - - Everything you need to know about Kit-tty for now is in the text that appears in the "TERMINAL" tab. - - - @@ -302,8 +196,7 @@ + label="ex-open-terminal-linux">

You will interact with Git using its command line interface via a Terminal. Use the following steps to open a Terminal. @@ -329,21 +222,6 @@ - - - -

- You will interact with Git using its command line interface via a Terminal. Use the following steps access the Terminal. -

-

- Click on the "TERMINAL" tab near the bottom of the development environment window to make the Terminal active. -

- - - @@ -604,8 +482,7 @@ + label="ex-restarting-dev-env-c">

Wait for the text similar to that in to appear and click the link. diff --git a/source/ch-communities-and-collaboration/sec-extra-practice.ptx b/source/ch-communities-and-collaboration/sec-extra-practice.ptx index eecf95c..f1764d1 100644 --- a/source/ch-communities-and-collaboration/sec-extra-practice.ptx +++ b/source/ch-communities-and-collaboration/sec-extra-practice.ptx @@ -111,8 +111,7 @@ + label="ex-extra-practice-clone-linux">

Clone your origin (i.e. your fork) for the project you selected into your development environment. @@ -127,25 +126,6 @@ - - - -

- Clone your origin (i.e. your fork) for the project you selected by creating a new development environment (i.e. workspace) for it in GitPod. Recall that creating a new GitPod workspace automatically clones the origin repository into the development environment. -

-

- Briefly describe how you created the the development environment, and thus cloned your origin, for the project you have chosen. -

- - - - Review for information about how to create a new GitPod workspace (i.e. development environment). - - - diff --git a/source/ch-instructor-guide/sec-instructor-communities.ptx b/source/ch-instructor-guide/sec-instructor-communities.ptx index ca6ba5e..cd121b0 100644 --- a/source/ch-instructor-guide/sec-instructor-communities.ptx +++ b/source/ch-instructor-guide/sec-instructor-communities.ptx @@ -174,12 +174,9 @@

- While the GitKit was designed for nominal delivery in four 50-75-minute periods with 2-3 hours of additional hands-on work by the students, instructors have found the GitKit to be adaptable to different educational settings, student experience levels and learning objectives. + While the GitKit was designed for nominal delivery in four 50-75-minute periods with 2-3 hours of additional hands-on work by the students, instructors have found the GitKit to be adaptable to different educational settings, student experience levels and learning objectives. Some examples include: