Skip to content

Commit 7a16b22

Browse files
authored
Update README.md
edits
1 parent 4da7902 commit 7a16b22

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55

66
---
77

8-
Here are the steps and information to add a new GitHub repository to the [Zipkin Lab Code Archive](https://zipkinlab.github.io/) front-face page, if you are one of the 'GitHub people'.
8+
Here are the steps and information to add a new GitHub repository to the <a href="https://zipkinlab.github.io/" style="color: #077907ff;">Zipkin Lab Code Archive</a> front-face page, if you are one of the 'GitHub people'.
99

10-
The lab archive is the website where all our code and data can 'live through eternity', and where we can direct people who ask about our analysis or data. The [Lab Code Archive](https://github.com/zipkinlab/zipkinlab.github.io) is a single repository that lives within the [Zipkin Lab's GitHub](https://github.com/zipkinlab) page. It creates and links the [Zipkin Lab Archive website](https://zipkinlab.github.io/) to all other repositories that are stored in the lab GitHub.
10+
The lab archive is the website where all our code and data can 'live through eternity', and where we can direct people who ask about our analysis or data. The <a href="https://github.com/zipkinlab/zipkinlab.github.io" style="color: #077907ff;">Lab Code Archive</a> is a single repository that lives within the <a href="https://github.com/zipkinlab" style="color: #077907ff;">Zipkin Lab's GitHub</a> page. It creates and links the <a href="https://zipkinlab.github.io/" style="color: #077907ff;">Zipkin Lab Archive website</a> to all other repositories that are stored in the lab GitHub.
1111

1212
<div align="center">
1313
<img src="assets/images/lab_page.png" alt="lab_page" width="600">
@@ -19,7 +19,7 @@ The lab archive is the website where all our code and data can 'live through ete
1919

2020
### 1 - Fork personal repository to Zipkin Lab GitHub
2121

22-
All repositories should be on the [Zipkin Lab GitHub](https://github.com/zipkinlab) and linked from there (not from personal GitHub accounts) to the front-facing page. So step one is **forking** someone's repository into it.
22+
All repositories should be on the <a href="https://github.com/zipkinlab" style="color: #077907ff;">Zipkin Lab GitHub</a> and linked from there (not from personal GitHub accounts) to the front-facing page. So step one is **forking** someone's repository into it.
2323

2424
- Navigate to the repository you want to fork.
2525
- Click the **Fork** button (top-right of the page).
@@ -31,29 +31,29 @@ All repositories should be on the [Zipkin Lab GitHub](https://github.com/zipkinl
3131

3232
### 2 - Gather required information
3333

34-
There are two documents to use as reference (available on the [Zipkin Lab Teams GitHub page](https://teams.microsoft.com/l/channel/19%3A15762ca26189456f989a45136b141e94%40thread.tacv2/GitHub?groupId=a1e331a0-3ad7-4671-a13e-3629dea6fd3b&tenantId=22177130-642f-41d9-9211-74237ad5687d)) to gather all the info you need:
34+
There are two documents to use as reference (available on the <a href="https://teams.microsoft.com/l/channel/19%3A15762ca26189456f989a45136b141e94%40thread.tacv2/GitHub?groupId=a1e331a0-3ad7-4671-a13e-3629dea6fd3b&tenantId=22177130-642f-41d9-9211-74237ad5687d" style="color: #077907ff;">Zipkin Lab Teams GitHub page</a>) to gather all the info you need:
3535

3636
- A checklist to track added papers, and what info you have or are still missing:
37-
[GithubProjects.xlsx](https://michiganstate.sharepoint.com/:x:/r/sites/STUOT-ResearchGroup/Shared%20Documents/GitHub/GithubProjects.xlsx)
37+
<a href="https://michiganstate.sharepoint.com/:x:/r/sites/STUOT-ResearchGroup/Shared%20Documents/GitHub/GithubProjects.xlsx" style="color: #077907ff;">GithubProjects.xlsx</a>
3838

3939
- A document with detailed instructions on what each field in the spreadsheet above is:
40-
[Github Project Checklist.docx](https://michiganstate.sharepoint.com/:w:/r/sites/STUOT-ResearchGroup/Shared%20Documents/GitHub/Github%20Project%20Checklist.docx)
40+
<a href="https://michiganstate.sharepoint.com/:w:/r/sites/STUOT-ResearchGroup/Shared%20Documents/GitHub/Github%20Project%20Checklist.docx" style="color: #077907ff;">Github Project Checklist.docx</a>
4141

4242
---
4343

4444
### 3 - Edit the front-facing page
4545

46-
- Edits are done in the [index.html](https://github.com/zipkinlab/zipkinlab.github.io/blob/master/index.html) file.
46+
- Edits are done in the <a href="https://github.com/zipkinlab/zipkinlab.github.io/blob/master/index.html" style="color: #077907ff;">index.html</a> file.
4747
- Insert your new HTML block **within the appropriate paper category** (e.g., community models, unmarked population models).
4848
- New papers go at the top of the section.
4949
- You can add information manually, or use the code automation below:
5050

5151
#### Automated version:
5252

53-
- The paper metadata goes into the [github_dat.csv](https://michiganstate.sharepoint.com/:x:/r/sites/STUOT-ResearchGroup/Shared%20Documents/GitHub/github_dat.csv) file template. Just download it and substitute the fields with the details of the paper you want to add.
53+
- The paper metadata goes into the <a href="https://michiganstate.sharepoint.com/:x:/r/sites/STUOT-ResearchGroup/Shared%20Documents/GitHub/github_dat.csv" style="color: #077907ff;">github_dat.csv</a> file template. Just download it and substitute the fields with the details of the paper you want to add.
5454

5555
<details>
56-
<summary>Click to see code that creates github_dat.csv</summary>
56+
<summary><span style="color: #077907ff; font-style: italic;">Click to see code from github_html.r</span></summary>
5757

5858
````r
5959
library(tidyverse)
@@ -76,10 +76,10 @@ There are two documents to use as reference (available on the [Zipkin Lab Teams
7676
<img src="assets/images/git_dat.png" alt="git_dat" width="400">
7777
</div>
7878

79-
- Now that you have the new `github_dat.csv` file in your working directory, run [github_html.r](https://michiganstate.sharepoint.com/:u:/r/sites/STUOT-ResearchGroup/Shared%20Documents/GitHub/github_html.r) to create the HTML code snippets that should be added to [index.html](https://github.com/zipkinlab/zipkinlab.github.io/blob/master/index.html).
79+
- Now that you have the new `github_dat.csv` file in your working directory, run <a href="https://michiganstate.sharepoint.com/:u:/r/sites/STUOT-ResearchGroup/Shared%20Documents/GitHub/github_html.r" style="color: #077907ff;">github_html.r</a> to create the HTML code snippets that should be added to <a href="https://github.com/zipkinlab/zipkinlab.github.io/blob/master/index.html" style="color: #077907ff;">index.html</a>.
8080

8181
<details>
82-
<summary>Click to see code from github_html.r</summary>
82+
<summary><span style="color: #077907ff; font-style: italic;">Click to see code from github_html.r</span></summary>
8383

8484
````r
8585
## code to create html file for the lab front-facing page
@@ -157,19 +157,19 @@ There are two documents to use as reference (available on the [Zipkin Lab Teams
157157
````
158158

159159
</details><br>
160-
- Paste the html code snippets from `git_text.txt` and `git_title.txt` into the [index.html](https://github.com/zipkinlab/zipkinlab.github.io/blob/master/index.html) file (you have to hit 'edit' and commit it!). <br>
160+
- Paste the html code snippets from `git_text.txt` and `git_title.txt` into the <a href="https://github.com/zipkinlab/zipkinlab.github.io/blob/master/index.html" style="color: #077907ff;">index.html</a> file (you have to hit 'edit' and commit it!). <br>
161161

162-
- Add a figure (.PNG) to the [assets/images/](https://github.com/zipkinlab/zipkinlab.github.io/tree/master/assets/images) folder on GitHub. The figure name should match the citation (e.g., `Zipkin_etal_2025_MEE.png`).
162+
- Add a figure (.PNG) to the <a href="https://github.com/zipkinlab/zipkinlab.github.io/tree/master/assets/images" style="color: #077907ff;">assets/images/</a> folder on GitHub. The figure name should match the citation (e.g., `Zipkin_etal_2025_MEE.png`).
163163

164164
---
165165

166166
### 4 - Add metadata to the `Archived-data` repository
167167

168-
- Upload the relevant data/code links to the [Archived-data repo](https://github.com/zipkinlab/Archived-data).
168+
- Upload the relevant data/code links to the <a href="https://github.com/zipkinlab/Archived-data" style="color: #077907ff;">Archived-data repo</a>.
169169

170170
---
171171

172-
#### Open the [Zipkin Lab Code Archive](https://zipkinlab.github.io/) to check if your edits are correct and...
172+
#### Open the <a href="https://zipkinlab.github.io/" style="color: #077907ff;">Zipkin Lab Code Archive</a> to check if your edits are correct and...
173173

174174
## 🎉 YAY, you are done!!!
175175
---

0 commit comments

Comments
 (0)