From e34ed0d9f3fe6c183af983ab56e8ead5e409f732 Mon Sep 17 00:00:00 2001 From: Kate Isaac <41767733+kweav@users.noreply.github.com> Date: Tue, 4 Jun 2024 18:30:29 -0400 Subject: [PATCH 1/4] talk about forks --- getting_started.Rmd | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/getting_started.Rmd b/getting_started.Rmd index 8586291..4d1f4a7 100644 --- a/getting_started.Rmd +++ b/getting_started.Rmd @@ -132,6 +132,36 @@ When updates are made to files that aren't specific to the course content but in - [File for the main course OTTR_Template updates](https://github.com/jhudsl/OTTR_Template/blob/main/.github/sync.yml) - [File for the OTTR_Quizzes updates](https://github.com/jhudsl/OTTR_Quizzes/blob/main/.github/sync.yml) +#### Making edits to these files if you're not part of the jhudsl GitHub organization + +If you're not part of the jhudsl GitHub organization, to edit the `sync.yml` file you'll need to + - fork the repo + - make the changes (described below) to `sync.yml`, committing them to a branch + - create a PR in the original OTTR repo using your branch + +Detailed instructions for these steps are provided below: + - Click the pencil in the upper right for "Fork this repository and edit the file" + - Click the green button that says "Fork this repository" + - Make the edits to the file, adding your repository's name where it says `#NEW REPO HERE#`. Be careful to indent the same amount as the other repositories listed. +![](https://raw.githubusercontent.com/jhudsl/OTTR_Template/main/resources/screenshots/edit-sync.yml.png) + - Click the green "Commit changes..." button. As the banner on the top of the page says, this will write your changes to a new branch in your fork so you can open a pull request. + - Add a commit message or extended description beyond what's there if you want to provide more info and click the green Propose Changes button. + - This will automatically open a new page comparing the changes from your branch to the original repo. Click the green "Create pull request" button to create a PR with your edits to the sync.yml file to the OTTR repo. + - Edit the title or provide an extended description beyond what's there if you want (if you already did that when you created your commit, GitHub will copy that over). Click the green "Create pull request" button. This will create a PR in the OTTR repo. + - To make sure that we see the PR, you'll want to add a comment with `@cansavvy` to alert us there's a PR that needs to be merged. Scroll down to "Add a comment", type the `@cansavvy`, and click the green "Comment" button. + +Some alternative information on these steps are available [here from GitHub](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) or from [James Priest's Gist on the Fork and PR Workflow](https://gist.github.com/james-priest/74188772ef2a6f8d7132d0b9dc065f9c) (note: you don't need to clone the forked repo locally, instead making edits online and committing to a new branch). + +If you'd rather not create a fork and open a PR, we can make edits to the `sync.yml` file for you if you open an issue in the relevant repo (links below) providing us the information about your repo (organization or username as well as the new repo name) or submit a response in our [OTTR Feedback Google Form](https://forms.gle/jGQnd5oemHWyuUq28) providing the information for your new repo in the "Do you have any overall suggestions for OTTR?" question. + +| Repository | Issues Link | +|:---------------------:|:---------------------------------------------------------------------------:| +| OTTR_Template | [Open an issue here](https://github.com/jhudsl/OTTR_Template/issues/new/choose) | +| OTTR_Quizzes | [Open an issue here](https://github.com/jhudsl/OTTR_Quizzes/issues/new/choose) | +| OTTR_Template_Website | [Open an issue here](https://github.com/jhudsl/OTTR_Template_Website/issues/new/choose)| + +#### Making edits to these files if you are part of the jhudsl GitHub organization + - Add your repository's name where it says `#NEW REPO HERE#`. Be careful to indent the same amount as the other repositories listed. ![](https://raw.githubusercontent.com/jhudsl/OTTR_Template/main/resources/screenshots/edit-sync.yml.png) - Click on `Commit changes...` @@ -139,7 +169,6 @@ When updates are made to files that aren't specific to the course content but in - Choose `Create a new branch for this commit and start a pull request.` Name the branch what you like. ![](https://raw.githubusercontent.com/jhudsl/OTTR_Template/main/resources/screenshots/add-repo-sync.png) - Click `Propose changes`. -- See [this guide](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) for any questions you have about creating a pull request from your forked repository. - Write a short pull request description describing that you are adding a new repository to the `sync.yml` file. - Click `Create Pull Request` - Request `@cansavvy` as a reviewer. From 95ef680452b7fc28fea7a520d2ec60e6909009fc Mon Sep 17 00:00:00 2001 From: Kate Isaac <41767733+kweav@users.noreply.github.com> Date: Thu, 13 Jun 2024 13:25:31 -0400 Subject: [PATCH 2/4] add links for new issue templates --- getting_started.Rmd | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/getting_started.Rmd b/getting_started.Rmd index 4d1f4a7..ffe8ad0 100644 --- a/getting_started.Rmd +++ b/getting_started.Rmd @@ -152,11 +152,11 @@ Detailed instructions for these steps are provided below: Some alternative information on these steps are available [here from GitHub](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) or from [James Priest's Gist on the Fork and PR Workflow](https://gist.github.com/james-priest/74188772ef2a6f8d7132d0b9dc065f9c) (note: you don't need to clone the forked repo locally, instead making edits online and committing to a new branch). -If you'd rather not create a fork and open a PR, we can make edits to the `sync.yml` file for you if you open an issue in the relevant repo (links below) providing us the information about your repo (organization or username as well as the new repo name) or submit a response in our [OTTR Feedback Google Form](https://forms.gle/jGQnd5oemHWyuUq28) providing the information for your new repo in the "Do you have any overall suggestions for OTTR?" question. +If you'd rather not create a fork and open a PR, we can make edits to the `sync.yml` file for you if you open an issue in the relevant repo (links in table below) providing us the information about your repo (organization or username as well as the new repo name) or submit a response in our [OTTR Feedback Google Form](https://forms.gle/jGQnd5oemHWyuUq28) providing the information for your new repo in the "Do you have any overall suggestions for OTTR?" question. -| Repository | Issues Link | -|:---------------------:|:---------------------------------------------------------------------------:| -| OTTR_Template | [Open an issue here](https://github.com/jhudsl/OTTR_Template/issues/new/choose) | +| Repository | Issues Links | +|:---------------------:|:---------------------------------------------------------------------------| +| OTTR_Template | [Open a general issue here](https://github.com/jhudsl/OTTR_Template/issues/new/choose)
[Open an issue to add a new repo to `sync.yml` for OTTR updates](https://github.com/jhudsl/OTTR_Template/issues/new?assignees=cansavvy&labels=&projects=&template=new-course-add-to-sync.md&title=)
[Open an issue to update your repo name/location in `sync.yml` for OTTR updates](https://github.com/jhudsl/OTTR_Template/issues/new?assignees=cansavvy&labels=&projects=&template=update-course-info-for-sync.md&title=)| | OTTR_Quizzes | [Open an issue here](https://github.com/jhudsl/OTTR_Quizzes/issues/new/choose) | | OTTR_Template_Website | [Open an issue here](https://github.com/jhudsl/OTTR_Template_Website/issues/new/choose)| From 5dd0ad2cb0f1ca5dc0a5c6db41e078b2135b0150 Mon Sep 17 00:00:00 2001 From: Kate Isaac <41767733+kweav@users.noreply.github.com> Date: Tue, 25 Jun 2024 22:58:12 -0400 Subject: [PATCH 3/4] try rearranging --- getting_started.Rmd | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/getting_started.Rmd b/getting_started.Rmd index ffe8ad0..cfe626b 100644 --- a/getting_started.Rmd +++ b/getting_started.Rmd @@ -127,12 +127,16 @@ When updates are made to files that aren't specific to the course content but in **To enroll in these automatic update pull requests, the new course's repository name will need to be added to [this file in the OTTR website template](https://github.com/jhudsl/OTTR_Template_Website/edit/main/.github/sync.yml)** +If you're a member of the jhudsl GitHub organization, you can make edits to the sync file in a new branch and open a pull request. + +If you're not a member of the jhudsl GitHub organization, to edit the sync file, you'd have to create a fork and open a pull request from that fork. We provide instructions for that below [in the section Making edits to these files if you are not part of the jhudsl Github organization](#making-edits-to-these-files-if-you-are-not-part-of-the-jhudsl-github-organization). However, if you'd rather not create a fork and open a PR, we can make edits to the `sync.yml` file for you if you open an issue in the relevant repo [(links in table below)](#links-to-open-an-issue-in-an-ottr-template-repository) providing us the information about your repo (organization or username as well as the new repo name) or submit a response in our [OTTR Feedback Google Form](https://forms.gle/jGQnd5oemHWyuUq28) providing the information for your new repo in the "Do you have any overall suggestions for OTTR?" question. + - Go to the respective file: `.github/sync.yml` of the OTTR template repository you created your repository from: - [File for the main course OTTR_Template_Website updates](https://github.com/jhudsl/OTTR_Template_Website/blob/main/.github/sync.yml) - [File for the main course OTTR_Template updates](https://github.com/jhudsl/OTTR_Template/blob/main/.github/sync.yml) - [File for the OTTR_Quizzes updates](https://github.com/jhudsl/OTTR_Quizzes/blob/main/.github/sync.yml) -#### Making edits to these files if you're not part of the jhudsl GitHub organization +#### Making edits to these files if you are not part of the jhudsl GitHub organization If you're not part of the jhudsl GitHub organization, to edit the `sync.yml` file you'll need to - fork the repo @@ -152,7 +156,7 @@ Detailed instructions for these steps are provided below: Some alternative information on these steps are available [here from GitHub](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) or from [James Priest's Gist on the Fork and PR Workflow](https://gist.github.com/james-priest/74188772ef2a6f8d7132d0b9dc065f9c) (note: you don't need to clone the forked repo locally, instead making edits online and committing to a new branch). -If you'd rather not create a fork and open a PR, we can make edits to the `sync.yml` file for you if you open an issue in the relevant repo (links in table below) providing us the information about your repo (organization or username as well as the new repo name) or submit a response in our [OTTR Feedback Google Form](https://forms.gle/jGQnd5oemHWyuUq28) providing the information for your new repo in the "Do you have any overall suggestions for OTTR?" question. +##### Links to open an Issue in an OTTR Template repository | Repository | Issues Links | |:---------------------:|:---------------------------------------------------------------------------| From e07fa2a6c63a23ad664ad8b33725a5fe3a25ec69 Mon Sep 17 00:00:00 2001 From: Kate Isaac <41767733+kweav@users.noreply.github.com> Date: Wed, 26 Jun 2024 15:14:57 -0400 Subject: [PATCH 4/4] bulleted list and a couple other clarity changes --- getting_started.Rmd | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/getting_started.Rmd b/getting_started.Rmd index cfe626b..56102de 100644 --- a/getting_started.Rmd +++ b/getting_started.Rmd @@ -120,23 +120,29 @@ For more information about GitHub Pages we recommend you refer to the GitHub doc ### 8. Enroll your repository for OTTR updates (Not required but highly encouraged) -This OTTR templates (https://github.com/jhudsl/OTTR_Template_Website) are always a work in progress. +These OTTR templates (https://github.com/jhudsl/OTTR_Template_Website or https://github.com/jhudsl/OTTR_Template) are always a work in progress. We are working on adding more features and smoothing out bugs as we go. This is also why [your feedback is greatly appreciated](https://github.com/jhudsl/OTTR_Template/issues/new/choose). When updates are made to files that aren't specific to the course content but instead run checks and other processes in the original repository, pull requests are filed automatically to any downstream repositories made from this template. -**To enroll in these automatic update pull requests, the new course's repository name will need to be added to [this file in the OTTR website template](https://github.com/jhudsl/OTTR_Template_Website/edit/main/.github/sync.yml)** +**To enroll in these automatic update pull requests, the new course's repository name will need to be added to the relevant OTTR template sync file. See [Which file should you edit section for links to the file you want](#which-sync-file-should-you-edit)** If you're a member of the jhudsl GitHub organization, you can make edits to the sync file in a new branch and open a pull request. -If you're not a member of the jhudsl GitHub organization, to edit the sync file, you'd have to create a fork and open a pull request from that fork. We provide instructions for that below [in the section Making edits to these files if you are not part of the jhudsl Github organization](#making-edits-to-these-files-if-you-are-not-part-of-the-jhudsl-github-organization). However, if you'd rather not create a fork and open a PR, we can make edits to the `sync.yml` file for you if you open an issue in the relevant repo [(links in table below)](#links-to-open-an-issue-in-an-ottr-template-repository) providing us the information about your repo (organization or username as well as the new repo name) or submit a response in our [OTTR Feedback Google Form](https://forms.gle/jGQnd5oemHWyuUq28) providing the information for your new repo in the "Do you have any overall suggestions for OTTR?" question. +If you're not a member of the jhudsl GitHub organization, you can use one of these alternatives: + +* Submit a response in our [OTTR Feedback Google Form](https://forms.gle/jGQnd5oemHWyuUq28) by providing the information for your new repo (organization or username as well as the new repo name) in the "Do you have any overall suggestions for OTTR?" question and we can make edits to the `sync.yml` file for you. +* Open an issue in the relevant repo [(links in table below)](#links-to-open-an-issue-in-an-ottr-template-repository) providing us the information about your repo (organization or username as well as the new repo name) and we can make edits to the `sync.yml` file for you. +* Edit the sync file by creating a fork and opening a pull request from that fork. We provide instructions for that below [in the section Making edits to these files if you are not part of the jhudsl Github organization](#making-edits-to-this-file-if-you-are-not-part-of-the-jhudsl-github-organization). + +#### Which sync file should you edit? - Go to the respective file: `.github/sync.yml` of the OTTR template repository you created your repository from: - - [File for the main course OTTR_Template_Website updates](https://github.com/jhudsl/OTTR_Template_Website/blob/main/.github/sync.yml) - [File for the main course OTTR_Template updates](https://github.com/jhudsl/OTTR_Template/blob/main/.github/sync.yml) + - [File for the website OTTR_Template_Website updates](https://github.com/jhudsl/OTTR_Template_Website/blob/main/.github/sync.yml) - [File for the OTTR_Quizzes updates](https://github.com/jhudsl/OTTR_Quizzes/blob/main/.github/sync.yml) -#### Making edits to these files if you are not part of the jhudsl GitHub organization +#### Making edits to this file if you are not part of the jhudsl GitHub organization If you're not part of the jhudsl GitHub organization, to edit the `sync.yml` file you'll need to - fork the repo @@ -164,7 +170,7 @@ Some alternative information on these steps are available [here from GitHub](htt | OTTR_Quizzes | [Open an issue here](https://github.com/jhudsl/OTTR_Quizzes/issues/new/choose) | | OTTR_Template_Website | [Open an issue here](https://github.com/jhudsl/OTTR_Template_Website/issues/new/choose)| -#### Making edits to these files if you are part of the jhudsl GitHub organization +#### Making edits to this file if you are part of the jhudsl GitHub organization - Add your repository's name where it says `#NEW REPO HERE#`. Be careful to indent the same amount as the other repositories listed. ![](https://raw.githubusercontent.com/jhudsl/OTTR_Template/main/resources/screenshots/edit-sync.yml.png)