Skip to content

Commit

Permalink
Render site
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Jun 26, 2024
1 parent 86b8745 commit 73cc907
Showing 1 changed file with 127 additions and 14 deletions.
141 changes: 127 additions & 14 deletions docs/getting_started.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -748,35 +748,151 @@ <h3>7. Set up GitHub Pages</h3>
class="section level3">
<h3>8. Enroll your repository for OTTR updates (Not required but highly
encouraged)</h3>
<p>This OTTR templates (<a
<p>These OTTR templates (<a
href="https://github.com/jhudsl/OTTR_Template_Website"
class="uri">https://github.com/jhudsl/OTTR_Template_Website</a>) are
always a work in progress. We are working on adding more features and
smoothing out bugs as we go. This is also why <a
class="uri">https://github.com/jhudsl/OTTR_Template_Website</a> or <a
href="https://github.com/jhudsl/OTTR_Template"
class="uri">https://github.com/jhudsl/OTTR_Template</a>) are always a
work in progress. We are working on adding more features and smoothing
out bugs as we go. This is also why <a
href="https://github.com/jhudsl/OTTR_Template/issues/new/choose">your
feedback is greatly appreciated</a>.</p>
<p>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.</p>
<p><strong>To enroll in these automatic update pull requests, the new
course’s repository name will need to be added to <a
href="https://github.com/jhudsl/OTTR_Template_Website/edit/main/.github/sync.yml">this
file in the OTTR website template</a></strong></p>
course’s repository name will need to be added to the relevant OTTR
template sync file. See <a href="#which-sync-file-should-you-edit">Which
file should you edit section for links to the file you
want</a></strong></p>
<p>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.</p>
<p>If you’re not a member of the jhudsl GitHub organization, you can use
one of these alternatives:</p>
<ul>
<li>Submit a response in our <a
href="https://forms.gle/jGQnd5oemHWyuUq28">OTTR Feedback Google Form</a>
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
<code>sync.yml</code> file for you.</li>
<li>Open an issue in the relevant repo <a
href="#links-to-open-an-issue-in-an-ottr-template-repository">(links in
table below)</a> providing us the information about your repo
(organization or username as well as the new repo name) and we can make
edits to the <code>sync.yml</code> file for you.</li>
<li>Edit the sync file by creating a fork and opening a pull request
from that fork. We provide instructions for that below <a
href="#making-edits-to-this-file-if-you-are-not-part-of-the-jhudsl-github-organization">in
the section Making edits to these files if you are not part of the
jhudsl Github organization</a>.</li>
</ul>
<div id="which-sync-file-should-you-edit" class="section level4">
<h4>Which sync file should you edit?</h4>
<ul>
<li>Go to the respective file: <code>.github/sync.yml</code> of the OTTR
template repository you created your repository from:
<ul>
<li><a
href="https://github.com/jhudsl/OTTR_Template_Website/blob/main/.github/sync.yml">File
for the main course OTTR_Template_Website updates</a></li>
<li><a
href="https://github.com/jhudsl/OTTR_Template/blob/main/.github/sync.yml">File
for the main course OTTR_Template updates</a></li>
<li><a
href="https://github.com/jhudsl/OTTR_Template_Website/blob/main/.github/sync.yml">File
for the website OTTR_Template_Website updates</a></li>
<li><a
href="https://github.com/jhudsl/OTTR_Quizzes/blob/main/.github/sync.yml">File
for the OTTR_Quizzes updates</a></li>
</ul></li>
</ul>
</div>
<div
id="making-edits-to-this-file-if-you-are-not-part-of-the-jhudsl-github-organization"
class="section level4">
<h4>Making edits to this file if you are not part of the jhudsl GitHub
organization</h4>
<p>If you’re not part of the jhudsl GitHub organization, to edit the
<code>sync.yml</code> file you’ll need to - fork the repo - make the
changes (described below) to <code>sync.yml</code>, committing them to a
branch - create a PR in the original OTTR repo using your branch</p>
<p>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
<code>#NEW REPO HERE#</code>. Be careful to indent the same amount as
the other repositories listed. <img
src="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 <code>@cansavvy</code> to alert us there’s a PR that needs
to be merged. Scroll down to “Add a comment”, type the
<code>@cansavvy</code>, and click the green “Comment” button.</p>
<p>Some alternative information on these steps are available <a
href="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">here
from GitHub</a> or from <a
href="https://gist.github.com/james-priest/74188772ef2a6f8d7132d0b9dc065f9c">James
Priest’s Gist on the Fork and PR Workflow</a> (note: you don’t need to
clone the forked repo locally, instead making edits online and
committing to a new branch).</p>
<div id="links-to-open-an-issue-in-an-ottr-template-repository"
class="section level5">
<h5>Links to open an Issue in an OTTR Template repository</h5>
<table>
<colgroup>
<col width="23%" />
<col width="76%" />
</colgroup>
<thead>
<tr class="header">
<th align="center">Repository</th>
<th align="left">Issues Links</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td align="center">OTTR_Template</td>
<td align="left"><a
href="https://github.com/jhudsl/OTTR_Template/issues/new/choose">Open a
general issue here</a><br/><a
href="https://github.com/jhudsl/OTTR_Template/issues/new?assignees=cansavvy&amp;labels=&amp;projects=&amp;template=new-course-add-to-sync.md&amp;title=">Open
an issue to add a new repo to <code>sync.yml</code> for OTTR
updates</a><br/><a
href="https://github.com/jhudsl/OTTR_Template/issues/new?assignees=cansavvy&amp;labels=&amp;projects=&amp;template=update-course-info-for-sync.md&amp;title=">Open
an issue to update your repo name/location in <code>sync.yml</code> for
OTTR updates</a></td>
</tr>
<tr class="even">
<td align="center">OTTR_Quizzes</td>
<td align="left"><a
href="https://github.com/jhudsl/OTTR_Quizzes/issues/new/choose">Open an
issue here</a></td>
</tr>
<tr class="odd">
<td align="center">OTTR_Template_Website</td>
<td align="left"><a
href="https://github.com/jhudsl/OTTR_Template_Website/issues/new/choose">Open
an issue here</a></td>
</tr>
</tbody>
</table>
</div>
</div>
<div
id="making-edits-to-this-file-if-you-are-part-of-the-jhudsl-github-organization"
class="section level4">
<h4>Making edits to this file if you are part of the jhudsl GitHub
organization</h4>
<ul>
<li>Add your repository’s name where it says
<code>#NEW REPO HERE#</code>. Be careful to indent the same amount as
the other repositories listed. <img
Expand All @@ -789,10 +905,6 @@ <h3>8. Enroll your repository for OTTR updates (Not required but highly
Name the branch what you like. <img
src="https://raw.githubusercontent.com/jhudsl/OTTR_Template/main/resources/screenshots/add-repo-sync.png" /></li>
<li>Click <code>Propose changes</code>.</li>
<li>See <a
href="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">this
guide</a> for any questions you have about creating a pull request from
your forked repository.</li>
<li>Write a short pull request description describing that you are
adding a new repository to the <code>sync.yml</code> file.</li>
<li>Click <code>Create Pull Request</code></li>
Expand All @@ -809,6 +921,7 @@ <h3>8. Enroll your repository for OTTR updates (Not required but highly
</p>
<p><br></p>
</div>
</div>
<div id="create-your-website-or-course" class="section level3">
<h3>Create your website or course</h3>
<p>Now you need to decide whether you want to build a course or a
Expand Down

0 comments on commit 73cc907

Please sign in to comment.