Skip to content

Commit

Permalink
docs: added software and github documentation
Browse files Browse the repository at this point in the history
* added documentation for Github integration
* added documentation for software archiving
  • Loading branch information
alejandromumo committed Dec 2, 2024
1 parent 8ad1ee7 commit 0a7cac9
Show file tree
Hide file tree
Showing 23 changed files with 300 additions and 35 deletions.
20 changes: 20 additions & 0 deletions content/help/docs/github/archive-software/contents.lr
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
_model: docspage
---
title: Archive software
---
menu: /help/docs/github
---
sort_key: 4
---
body:
---
docs:
#### docstext ####
text:
This section explains how to archive software records in [Software Heritage](https://www.softwareheritage.org/) through Zenodo.

All the software records with a single compressed file are considered for archival, this guide covers the following methods:

#### docstoc ####
menu: /help/docs/github/archive-software

Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
_model: docspage
---
title: Archive a release from Github
---
menu: /help/docs/github
---
sort_key: 1
---
body:
This guide will help you create a **Software** record to be archived in [Software Heritage](https://www.softwareheritage.org/). It assumes you have already enabled a repository.

If you need help to enable a repository, read the following guide:

- [Enable a repository](../../enable-repository)
---
docs:
#### docsheader ####
text: Create a release
----
ref:create-a-release
#### docsstep ####
step: 1
----
text: Open the profile menu and click **Github**
----
image: profile.png
#### docsstep ####
step: 2
----
text: Select the repository
----
image: enabled_repos.png
#### docsstep ####
step: 3
----
text: Click the **Create release** button
----
image: create-release.png
#### docsstep ####
step: 4
----
text:

Create a release in Github. Find more information on how to manage releases here:

- [Managing releases in a repository](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository)
----
image:
#### docsstep ####
step: 5
----
text:

Wait for the release to be processed.

This could take some time, depending on the size of the release file and the load of Zenodo at that time.
----
image:
#### docsstep ####
step: 6
----
text: When the release is finished, click the record DOI to go to the record
----
image: release.png
----
#### docsstep ####
step: 7
----
text: In the record page, check the archival status under **External resources** > **Archived in**. The record will be archived soon.
----
image: ../manual-upload/archive-wait.png
----
#### docsheader ####
text: Debug a failed release
#### docsstep ####
step: 1
----
text: Select the repository (see step 2 above)
----
#### docsstep ####
step: 2
----
text: Select the failed release
----
image: failed-release.png
#### docsstep ####
step: 3
----
text: In the collapsable window that just open, select **Errors**
----
#### docsstep ####
step: 4
----
text: Check if the error is related to your release metadata. If so, you can fix it and release your software again.

**Note**: you can use tools such as [cff-converter](https://github.com/citation-file-format/cff-converter-python) to validate your `CITATION.cff` file.
**Note**: we provide complete [examples](../../describe-software) of `CITATION.cff` and `.zenodo.json` files.
----
image: failed-release-errors.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
_model: docspage
---
title: Upload software manually
---
menu: /help/docs/github
---
sort_key: 1
---
body:
This guide will help you create a **Software** record to be archived in [Software Heritage](https://www.softwareheritage.org/). It assumes you have already created (but not published) a new upload. If you need help starting a new upload, read the following guide:

- [Create a new upload](https://help.zenodo.org/docs/deposit/create-new-upload/#new-upload)

---
docs:

#### docsheader ####

text: Create a software deposit

----
#### docsstep ####
step: 1
----
text:

In the deposit form of your upload, add a single **ZIP** file that contains your software's source code

**NOTE**: It is mandatory that only one compressed file (e.g. ZIP) is present in the record. Otherwise, the record is deemed invalid and not archived in Software Heritage

----
image: https://codimd.web.cern.ch/uploads/upload_5c2f71987c22ea0a41d5868dcd268e0f.png
----
#### docsstep ####
step: 2
----
text: Under *Resource type* select **Software**
----
image: https://codimd.web.cern.ch/uploads/upload_362d7ed8d76e99d0bb38cca0f208d868.png
----
#### docsstep ####
step: 3
----
text: Describe the record according to your needs. Learn more about the deposit form fields here:

- [Describe records](https://help.zenodo.org/docs/deposit/describe-records/)
----
#### docsstep ####
step: 4
----
text: It is strongly suggested to use software-specific fields. To do so, scroll-down to the *Software* category:
----
image: https://codimd.web.cern.ch/uploads/upload_cd2c5679f034671be3f70591cf58062d.png
----
#### docsstep ####
step: 5
----
text: Publish the record
----
#### docsstep ####
step: 6
----
text: In the record page, check the archival status under **External resources** > **Archived in**. The record will be archived soon.
----
image: archive-wait.png
9 changes: 0 additions & 9 deletions content/help/docs/github/citation-file/contents.lr

This file was deleted.

10 changes: 6 additions & 4 deletions content/help/docs/github/contents.lr
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
_model: docspage
---
_hidden: true
_hidden: false
---
title: GitHub
title: GitHub and Software
---
sort_key: 10
---
menu: /help/docs/github
---
body:

bla bla
---
docs:
#### docstext ####
text: This section covers the Zenodo/GitHub integration and provides details on how software records are archived in [Software Heritage](https://www.softwareheritage.org/)
#### docstoc ####
menu: /help/docs/github
9 changes: 0 additions & 9 deletions content/help/docs/github/create-release/contents.lr

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
_model: docspage
---
title: CITATION.cff file
---
menu: /help/docs/github
---
sort_key: 2
---
body:
CITATION stuff
---
docs:
#### docsheader ####
text: Create a CITATION.cff file
#### docsheader ####
text: Validate a CITATION.cff file

25 changes: 25 additions & 0 deletions content/help/docs/github/describe-software/contents.lr
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
_model: docspage
---
title: Describe software
---
menu: /help/docs/github
---
sort_key: 3
---
body:
---
docs:
#### docstext ####
text:
The metadata schema used by Zenodo was extended with fields based on the [CodeMeta](https://codemeta.github.io/) standard, providing support for software-specific metadata.

Moreover, Zenodo supports `CITATION.cff` and `.zenodo.json` files for software releases originating from GitHub, enhancing the integration and making the content easier to cite.

Find more information about citing content on Github here:

- [Referencing and citing content](https://docs.github.com/en/repositories/archiving-a-github-repository/referencing-and-citing-content)

These are the supported methods to describe software records:
#### docstoc ####
menu: /help/docs/github/describe-software

16 changes: 16 additions & 0 deletions content/help/docs/github/describe-software/zenodo-json/contents.lr
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
_model: docspage
---
title: Zenodo JSON file
---
menu: /help/docs/github
---
sort_key: 3
---
body:
.zenodo.json
---
docs:
#### docsheader ####
text: Create a .zenodo.json file


56 changes: 52 additions & 4 deletions content/help/docs/github/enable-repository/contents.lr
Original file line number Diff line number Diff line change
@@ -1,9 +1,57 @@
_model: docspage
---
title: Enable repository
---
docs:
title: Enable a repository
---
menu: /help/docs/github
---
sort_key: 2
sort_key: 1
---
body:

This guide will walk you through the steps to enable a GitHub repository for integration, ensuring it is properly linked. Once connected, new releases from the repository will be automatically ingested and archived.

As a prerequisite, make sure you have a connected Github account. Learn here how to connect your account here:

- [Linking your GitHub/ORCID/OpenAIRE account](https://help.zenodo.org/docs/profile/linking-accounts/)

---
docs:

#### docsheader ####

text: Enable a repository
----
#### docsstep ####
step: 1
----
docstext: Click the profile menu in the header and click **Github**
----
image: profile.png
----
#### docsstep ####
step: 2
----
text: Click **Sync now** in the header
----
image: sync.png
----
#### docsstep ####
step: 3
----
text: Find a repository you wish to enable, then toggle the slider to connect it to Zenodo
----
image: repos.png
----
#### docsstep ####
step: 4
----
text: The repository is now connected to Zenodo:
----
image: success_repo.png
----
#### docsstep ####
step: 5
----
text: Refresh the page to update the list of enabled repositories
----
image: enabled_repos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 0 additions & 9 deletions content/help/docs/github/link-account/contents.lr

This file was deleted.

0 comments on commit 0a7cac9

Please sign in to comment.