Skip to content

Commit

Permalink
Built site for gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
Quarto GHA Workflow Runner committed Nov 9, 2023
1 parent a1cd468 commit 69c9bbb
Show file tree
Hide file tree
Showing 6 changed files with 33 additions and 17 deletions.
2 changes: 1 addition & 1 deletion .nojekyll
Original file line number Diff line number Diff line change
@@ -1 +1 @@
6e003455
50b23a28
6 changes: 3 additions & 3 deletions coding.html
Original file line number Diff line number Diff line change
Expand Up @@ -245,13 +245,13 @@ <h1 class="title">Code as scientific product</h1>
<p>Codes are part of the scientific products your Lab is producing. It is thus important to manage, document, and preserve them as you would do for any other of your scientific products. In this session, we will discuss tools and practices that can ease the management of your codes, as well as develop them in a collaborative way.</p>
<section id="code-repository" class="level2">
<h2 class="anchored" data-anchor-id="code-repository">Code repository</h2>
<p>As data repositories, code repositories are a great way to preserve and share your code (including with your future self!!). One you might have already heard of is GitHub. However, there are others such as GitLab, Bitbucket Source Forge, and more.</p>
<p>Today we will be focusing on using GitHub to collaborate and keep track of the development of our scripts and other code.</p>
<p>As data repositories, code repositories are a great way to preserve and share your code (including with your future self!!). One you might have already heard of is GitHub. However, there are other options such as GitLab, Bitbucket Source Forge, and more.</p>
<p>Today we will be focusing on using GitHub to collaborate and keep track of the development of our scripts.</p>
<ul>
<li>Quick intro to GitHub
<ul>
<li>Why</li>
<li>Website interface walkthrough</li>
<li>Website interface walk through</li>
</ul></li>
<li>Github Organizations
<ul>
Expand Down
13 changes: 11 additions & 2 deletions collab_exchange.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">


<title>Designing a Reproducible and Collaborative Lab (RCL) - collab_exchange</title>
<title>Designing a Reproducible and Collaborative Lab (RCL) - Code Review Exchange</title>
<style>
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
Expand Down Expand Up @@ -221,7 +221,7 @@

<header id="title-block-header" class="quarto-title-block default">
<div class="quarto-title">
<h1 class="title">collab_exchange</h1>
<h1 class="title">Code <del>Review</del> Exchange</h1>
</div>


Expand All @@ -236,6 +236,15 @@ <h1 class="title">collab_exchange</h1>

</header>

<p>Code Exchange is an asynchronous activity that takes place when a teammate is finished working on an script (or a part of). This teammate will submit a request to another team memeber to look over the code and provide feedback. It is a great way to:</p>
<ul>
<li>Have one more pair of eyes looking at your code to detect potential bugs / improvements, including analytical aspects of the code</li>
<li>Motivate development of good documentation</li>
<li>Generate conversation about code styling</li>
<li>Have several team members sharing knowledge</li>
<li>Great way to onboard new team members both in terms of code knowledge but also code styling</li>
</ul>
<p>The Reviewer should see this activity as a great way to learn from others through <strong>constructive</strong> feedback… and so should the Submitter!!</p>



Expand Down
2 changes: 1 addition & 1 deletion collab_pairprog.html
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ <h1 class="title">Pair Programming</h1>
<p>Pair programming is an <em>synchronous</em> team activity, where several programmers get to work together on the same piece of code. This is a great way to gain a better sense of what coding style people are using and better understand their way of solving challenges. It is also a great way to learn from each other. Generally, there is one Driver who is the person typing at the computer. The other role is called Navigator(s). The Navigator does not write code and focuses on finding solutions to the problem. Their use of computer should be limited to searching online for solutions.</p>
<section id="basic-principles-practices" class="level2">
<h2 class="anchored" data-anchor-id="basic-principles-practices">Basic principles &amp; practices</h2>
<p>Adapted from Woody Zuill https://www.agileconnection.com/article/getting-started-mob-programming</p>
<p>Adapted from Woody Zuill <a href="https://www.agileconnection.com/article/getting-started-mob-programming" class="uri">https://www.agileconnection.com/article/getting-started-mob-programming</a></p>
<ul>
<li><strong>Treat each other with kindness, consideration, and respect</strong> - makes group work more fun and sustainable</li>
<li><strong>Driver/navigator pair programming adapted to work with the whole team</strong> - “For an idea to go from your head into the computer, it <em>must</em> go through someone else’s hands.” Speak at the highest level of abstraction that the driver (and the rest of the team) is able to digest at the moment</li>
Expand Down
9 changes: 8 additions & 1 deletion search.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,13 @@
"section": "Leveraging teams",
"text": "Leveraging teams\nLet’s create a new repository and use our newly created teams to add several collaborators at once.\n\n\n\n\n\nUnder your newly created organization, create a new repository with the following settings:\n\n\n\n\n\nOnce the repository created, click on the Settings tab (top right in the grey bar)\n\n\n\n\n\n{fig-align=“center” width=70%}On the left panel, click on Collaborators and teams and then click on the green button Add teams\n\n\n\n\n\nStart typing the name of the team you would like to add. Suggestions of teams should come up as you type. Select the relevant team by clicking on the suggestion.\n\n\n\n\n\nFor close collaborators, we recommend to use the Maitain level of access that provides a good blend of people being able to do most of the actions they will need to do while not being allowed to conduct destructive actions on accident (like deleting the entire repository). For collaborators you are less familiar with, including their familiarity with GitHub, you might want to start with the Write access.\n\n\n\n\n\nOnce the team added, your settings should look as follow:\n\n\n\n\n\nThe good news is now if you add a collaborator to a specific team, this person will automatically gain access to all the repositories that team as access to! This will streamline the on and off boarding process of your team memebers."
},
{
"objectID": "collab_exchange.html",
"href": "collab_exchange.html",
"title": "Code Review Exchange",
"section": "",
"text": "Code Exchange is an asynchronous activity that takes place when a teammate is finished working on an script (or a part of). This teammate will submit a request to another team memeber to look over the code and provide feedback. It is a great way to:\n\nHave one more pair of eyes looking at your code to detect potential bugs / improvements, including analytical aspects of the code\nMotivate development of good documentation\nGenerate conversation about code styling\nHave several team members sharing knowledge\nGreat way to onboard new team members both in terms of code knowledge but also code styling\n\nThe Reviewer should see this activity as a great way to learn from others through constructive feedback… and so should the Submitter!!"
},
{
"objectID": "coding.html",
"href": "coding.html",
Expand All @@ -39,7 +46,7 @@
"href": "coding.html#code-repository",
"title": "Code as scientific product",
"section": "Code repository",
"text": "Code repository\nAs data repositories, code repositories are a great way to preserve and share your code (including with your future self!!). One you might have already heard of is GitHub. However, there are others such as GitLab, Bitbucket Source Forge, and more.\nToday we will be focusing on using GitHub to collaborate and keep track of the development of our scripts and other code.\n\nQuick intro to GitHub\n\nWhy\nWebsite interface walkthrough\n\nGithub Organizations\n\nWhy\nsetup\nmanage: teams and settings\n\nStreamlining documentation with templates\n\nRepo\nIssues\nProjects\n\nCollaborative coding\n\nPair Programming\nCode Exchange via pull request"
"text": "Code repository\nAs data repositories, code repositories are a great way to preserve and share your code (including with your future self!!). One you might have already heard of is GitHub. However, there are other options such as GitLab, Bitbucket Source Forge, and more.\nToday we will be focusing on using GitHub to collaborate and keep track of the development of our scripts.\n\nQuick intro to GitHub\n\nWhy\nWebsite interface walk through\n\nGithub Organizations\n\nWhy\nsetup\nmanage: teams and settings\n\nStreamlining documentation with templates\n\nRepo\nIssues\nProjects\n\nCollaborative coding\n\nPair Programming\nCode Exchange via pull request"
},
{
"objectID": "github_org.html",
Expand Down
18 changes: 9 additions & 9 deletions sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,38 +2,38 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://github.com/UCSB-Library-Research-Data-Services/reproducible-lab/github_teams.html</loc>
<lastmod>2023-11-08T18:43:25.093Z</lastmod>
<lastmod>2023-11-09T05:22:47.028Z</lastmod>
</url>
<url>
<loc>https://github.com/UCSB-Library-Research-Data-Services/reproducible-lab/collab_exchange.html</loc>
<lastmod>2023-11-08T18:43:24.316Z</lastmod>
<lastmod>2023-11-09T05:22:46.208Z</lastmod>
</url>
<url>
<loc>https://github.com/UCSB-Library-Research-Data-Services/reproducible-lab/coding.html</loc>
<lastmod>2023-11-08T18:43:23.536Z</lastmod>
<lastmod>2023-11-09T05:22:45.300Z</lastmod>
</url>
<url>
<loc>https://github.com/UCSB-Library-Research-Data-Services/reproducible-lab/data_mgmt.html</loc>
<lastmod>2023-11-08T18:43:22.804Z</lastmod>
<lastmod>2023-11-09T05:22:44.452Z</lastmod>
</url>
<url>
<loc>https://github.com/UCSB-Library-Research-Data-Services/reproducible-lab/github_org.html</loc>
<lastmod>2023-11-08T18:43:20.732Z</lastmod>
<lastmod>2023-11-09T05:22:43.312Z</lastmod>
</url>
<url>
<loc>https://github.com/UCSB-Library-Research-Data-Services/reproducible-lab/github_template.html</loc>
<lastmod>2023-11-08T18:43:22.488Z</lastmod>
<lastmod>2023-11-09T05:22:44.096Z</lastmod>
</url>
<url>
<loc>https://github.com/UCSB-Library-Research-Data-Services/reproducible-lab/index.html</loc>
<lastmod>2023-11-08T18:43:23.176Z</lastmod>
<lastmod>2023-11-09T05:22:44.888Z</lastmod>
</url>
<url>
<loc>https://github.com/UCSB-Library-Research-Data-Services/reproducible-lab/collab_pairprog.html</loc>
<lastmod>2023-11-08T18:43:24.000Z</lastmod>
<lastmod>2023-11-09T05:22:45.820Z</lastmod>
</url>
<url>
<loc>https://github.com/UCSB-Library-Research-Data-Services/reproducible-lab/github_intro.html</loc>
<lastmod>2023-11-08T18:43:24.628Z</lastmod>
<lastmod>2023-11-09T05:22:46.560Z</lastmod>
</url>
</urlset>

0 comments on commit 69c9bbb

Please sign in to comment.