Skip to content

Commit aab7d4b

Browse files
committed
- Removed the Open/Closed project folders from an earlier structure.
- Updated to fix many of the issues with non-relative links.
1 parent dffbc50 commit aab7d4b

10 files changed

Lines changed: 27 additions & 58 deletions

File tree

KB/Guides/Github-desktop.qmd

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,11 @@ In this section, we will walk you through setting up a GitHub repository for a c
9292

9393

9494
## Tracking changes
95-
Now that you have set up your collaborative Kaggle hackathon repository, it's time to start working on your project and track the changes you make. In this section, we will guide you through the process of adding files to your local repository, viewing and committing changes, and pushing those changes to the remote repository on GitHub. By understanding how to track changes effectively, you and your team can ensure that all contributions are recorded, reviewed, and integrated smoothly into the project.
95+
Now that you have set up your collaborative Kaggle hackathon repository, it's time to start working on your project
96+
and track the changes you make. In this section, we will guide you through the process of adding files to your local
97+
repository, viewing and committing changes, and pushing those changes to the remote repository on GitHub. By
98+
understanding how to track changes effectively, you and your team can ensure that all contributions are recorded,
99+
reviewed, and integrated smoothly into the project.
96100

97101
1. **Add a blank text file to your local repo**
98102
1. Right-click repo name in GitHub Desktop → show in explorer (show in Finder and go to the directory on Mac)
@@ -110,7 +114,11 @@ Now that you have set up your collaborative Kaggle hackathon repository, it's ti
110114

111115

112116
## Ignoring .ipynb files
113-
As you collaborate on your Kaggle hackathon project, you may encounter challenges with tracking changes in Jupyter notebooks (.ipynb files) due to their complex JSON format. These files can include a lot of metadata that makes version control difficult and cluttered. In this section, we'll show you how to use Jupytext to convert your Jupyter notebooks into a more manageable format and configure your repository to ignore .ipynb files. This approach will help you maintain a cleaner version history and focus on the actual code changes, making collaboration more efficient.
117+
As you collaborate on your Kaggle hackathon project, you may encounter challenges with tracking changes in Jupyter
118+
notebooks (.ipynb files) due to their complex JSON format. These files can include a lot of metadata that makes
119+
version control difficult and cluttered. In this section, we'll show you how to use Jupytext to convert your Jupyter
120+
notebooks into a more manageable format and configure your repository to ignore .ipynb files. This approach will help
121+
you maintain a cleaner version history and focus on the actual code changes, making collaboration more efficient.
114122

115123
1. **Add jupyter lab file to repo**
116124
1. Open anaconda prompt and cd into your local repo folder
@@ -146,7 +154,11 @@ As your team collaborates on the Kaggle hackathon project, it's essential to sta
146154

147155

148156
## Reverting to a previous commit
149-
During the course of your Kaggle hackathon project, there may be times when you need to revert to a previous version of your code. This could be due to a bug, an unwanted change, or simply the need to return to a stable state. In this section, we'll guide you through the process of reverting to a previous commit using GitHub Desktop. Understanding how to revert to an earlier commit ensures that you can quickly and safely undo changes, helping your team maintain a stable and functional codebase throughout the competition.
157+
During the course of your Kaggle hackathon project, there may be times when you need to revert to a previous version
158+
of your code. This could be due to a bug, an unwanted change, or simply the need to return to a stable state. In this
159+
section, we'll guide you through the process of reverting to a previous commit using GitHub Desktop. Understanding
160+
how to revert to an earlier commit ensures that you can quickly and safely undo changes, helping your team maintain
161+
a stable and functional codebase throughout the competition.
150162

151163
1. **Find the Commit to Revert To**
152164
1. Open GitHub Desktop and navigate to the repository you are working on.

KB/Guides/How-to-contribute.qmd

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,10 @@ Ensure the resource is easy to access and use. We want the majority of resources
4949
Include links to related materials or further readings that can enhance the user’s understanding and provide more in-depth knowledge on the topic. This can include books, articles, other workshops, or case studies. When possible, link to any relevant materials which are already hosted on the Nexus platform.
5050

5151
### Examples of good posts
52-
Please see below for a list of resources that meet our platform's standards. You can use these examples in conjunction with the template files provided in the next section to create your post. You can click "Improve this page" near the top right of each resource page to view the corresponding quarto file (.qmd) and code, or find the file in the [GitHub repo](https://github.com/UW-Madison-DataScience/UW-RSE-Nexus).
52+
Please see below for a list of resources that meet our platform's standards. You can use these examples in conjunction
53+
with the template files provided in the next section to create your post. You can click "Improve this page" near the
54+
top right of each resource page to view the corresponding quarto file (.qmd) and code, or find the file in the
55+
[GitHub repo](https://github.com/UW-Madison-DataScience/UW-RSE-Nexus).
5356

5457
#### External content
5558

@@ -81,7 +84,7 @@ The high-level steps include :
8184

8285
If you don't know how to use Git / GitHub already, it can be a little intimidating at first. A friendlier
8386
alternative could be to [download GitHub desktop](https://desktop.github.com/) and add your post using the instructions provided below.
84-
If you'd like to learn more about GitHub Desktop, check out the [Version Control with GitHub Desktop](https://uw-madison-datascience.github.io/ML-X-Nexus/Learn/Guides/Github-desktop.html) guide
87+
If you'd like to learn more about GitHub Desktop, check out the [Version Control with GitHub Desktop](/KB/Guides/Github-desktop.qmd) guide
8588
on Nexus. If you need additional help (and work in a research lab at UW-Madison), you may also seek help at the
8689
Data Science Hub's [office hours ("Coding Meetup")](https://datascience.wisc.edu/hub/#dropin).
8790

KB/Presentations/index.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ page-layout: full
1919
title-block-banner: false
2020
---
2121
Explore past presentations given at UW RSE events. If you have an upcomming presentation or have already given one,
22-
feel free to [contribute](https://uw-madison-datascience.github.io/UW-RSE-Nexus/KB/Guides/How-to-contribute.html).
22+
feel free to [contribute](/KB/Guides/How-to-contribute.qmd).

KB/Resources/index.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ page-layout: full
1919
title-block-banner: false
2020
---
2121
Explore Research Software Engineering resources, on and off campus. If something is missing, please feel free to
22-
[contribute](https://uw-madison-datascience.github.io/UW-RSE-Nexus/KB/Guides/How-to-contribute.html).
22+
[contribute](/KB/Guides/How-to-contribute.qmd).

KB/index.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,5 @@ toc-location: body
2424
page-layout: full
2525
title-block-banner: false
2626
---
27-
Explore previous UW RSE community presentations, projects and other resources. Feel free to [contribute](https://uw-madison-datascience.github.io/UW-RSE-Nexus/KB/Guides/How-to-contribute.html) if you have
27+
Explore previous UW RSE community presentations, projects and other resources. Feel free to [contribute](/KB/Guides/How-to-contribute.qmd) if you have
2828
something related to share.

Projects/Closed/index.qmd

Lines changed: 0 additions & 23 deletions
This file was deleted.

Projects/Open/index.qmd

Lines changed: 0 additions & 23 deletions
This file was deleted.

Projects/index.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,5 @@ page-layout: full
1919
title-block-banner: false
2020
---
2121
Explore projects created, managed, or loved by UW RSE community members. If you have a project to share or are looking
22-
for contributions, please feel free to [contribute](https://uw-madison-datascience.github.io/UW-RSE-Nexus/KB/Guides/How-to-contribute.html)
22+
for contributions, please feel free to [contribute](/KB/Guides/How-to-contribute.qmd)
2323
a "Projects" page.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# UW RSE Community
22

3-
![UW RSE Banner](https://uw-madison-datascience.github.io/UW-RSE-Nexus/images/UW-RSE_Logo_Secondary_Transparent.png)
3+
![UW RSE Banner](/images/UW-RSE_Logo_Secondary_Transparent.png)
44

55
Welcome to the GitHup repo for UW RSE Nexus! Nexus is the UW RSE community’s centralized hub for sharing Research
66
Software Engineering (RSE) resources. Visit the [UW RSE website](https://hub.datascience.wisc.edu/communities/research-software-engineering-community/)
@@ -12,7 +12,7 @@ to stay informed on upcoming community events!
1212
This platform serves as a centralized hub for individuals interested in advancing their knowledge and skills in
1313
Research Software Engineering. Whether you're a student, researcher, or industry professional, you'll find a wealth
1414
of curated resources tailored to various experience levels and areas of interest. Visit the
15-
[UW RSE Nexus website](https://uw-madison-datascience.github.io/UW-RSE-Nexus/) to begin exploring RSE resources.
15+
[UW RSE Nexus website](/index.qmd) to begin exploring RSE resources.
1616

1717
## Features:
1818

index.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,5 +43,5 @@ study, you can proudly call yourself a Research Software Engineer.
4343
### Share your knowledge on Nexus!
4444
This site is powered by contributions from Research Software Engineers like you. If you have a project or other
4545
Research Software Engineering related resources to share, consider adding it to the UW RSE Nexus. Learn more on our
46-
[How to contribute](https://uw-madison-datascience.github.io/UW-RSE-Nexus/KB/Guides/How-to-contribute.html) page.
46+
[How to contribute](/KB/Guides/How-to-contribute.qmd) page.
4747

0 commit comments

Comments
 (0)