Skip to content

Commit

Permalink
rename cross-ref from cite-code to cite-zenodo to avoid name collision
Browse files Browse the repository at this point in the history
  • Loading branch information
willingc committed Oct 23, 2024
1 parent 0976330 commit fcfd666
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion publish-share-code/activity-1-share-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ If not, you can start with the [pyospackage repository](https://github.com/pyOpe

## Activity 2: Connect your Python package repo to Zenodo

In this activity, you will connect the GitHub repository containing a Python package to [Zenodo to create a DOI (Digital Object Identifier)](cite-code) for your code. This will allow others to cite your work and give credit to contributors.
In this activity, you will connect the GitHub repository containing a Python package to [Zenodo to create a DOI (Digital Object Identifier)](cite-zenodo) for your code. This will allow others to cite your work and give credit to contributors.

If you completed **Activity 1** above, you should already have a GitHub repository set up. Now, we’ll take it a step further by setting up a citation for your project using Zenodo.

Expand Down
2 changes: 1 addition & 1 deletion publish-share-code/cite-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ kernelspec:

+++ {"editable": true, "slideshow": {"slide_type": ""}}

(cite-code)=
(cite-zenodo)=
# Cite your code

[Share your code on an online platform like GitHub or GitLab](share-code) using an [open license](open-license) is a great way to share your code. It's also important to consider making your code citable. To understand citations, it's important to understand what a DOI is.
Expand Down
2 changes: 1 addition & 1 deletion publish-share-code/share-code-github.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Hosting code on GitHub helps you manage your projects, track changes, and keep y

## Cite your code

Even if you haven't published your code in an academic Journal, you can create a DOI that allows you to cite it using [Zenodo](cite-code). While you can upload code and other types of documents to Zenodo at any time, if you are using GitHub, you can create a direct connection, which will not only provide a DOI for the GitHub repository but also allow you to create new sub-DOIs for every new version of your code that you make.
Even if you haven't published your code in an academic Journal, you can create a DOI that allows you to cite it using [Zenodo](cite-zenodo). While you can upload code and other types of documents to Zenodo at any time, if you are using GitHub, you can create a direct connection, which will not only provide a DOI for the GitHub repository but also allow you to create new sub-DOIs for every new version of your code that you make.


<!--
Expand Down
2 changes: 1 addition & 1 deletion publish-share-code/share-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ kernelspec:

Sharing your code online using [open licenses](https://www.pyopensci.org/python-package-guide/documentation/repository-files/license-files.html) is a powerful way to make your work more open and collaborative, supporting the principles of open science. By openly sharing your code, you can set clear guidelines on how others can use, modify, and distribute it through licensing, ensuring that your contributions are respected.

When your code is hosted on a shared platform, others can easily download, install, and use it, making it more accessible and useful to the broader community. Additionally, you can set up proper citations for your code, giving contributors and yourself credit for the work and promoting transparency. [Learn more about setting up citation in our lesson on citing code.](cite-code)
When your code is hosted on a shared platform, others can easily download, install, and use it, making it more accessible and useful to the broader community. Additionally, you can set up proper citations for your code, giving contributors and yourself credit for the work and promoting transparency. [Learn more about setting up citation in our lesson on citing code.](cite-zenodo)

There are several ways to share code.
1. You can post your code to an online repository like GitHub or GitLab.
Expand Down

0 comments on commit fcfd666

Please sign in to comment.