Skip to content

Commit

Permalink
Update portfolio.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DaveBeardwood authored Jul 29, 2024
1 parent 1774479 commit 2a1eab3
Showing 1 changed file with 22 additions and 12 deletions.
34 changes: 22 additions & 12 deletions rs-impact/portfolio.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,29 @@ parent: Research Software and Research Impact
nav_order: 3
---

## Building Your Researcher Portfolio with ORCID ID
## Building Your Researcher Portfolio with ORCID

Check warning on line 8 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L8

[Google.Headings] 'Building Your Researcher Portfolio with ORCID' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Building Your Researcher Portfolio with ORCID' should use sentence-style capitalization.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 8, "column": 4}}}, "severity": "WARNING"}

Check notice on line 8 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L8

[Google.Acronyms] Spell out 'ORCID', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'ORCID', if it's unfamiliar to the audience.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 8, "column": 44}}}, "severity": "INFO"}

DOIs and ORCID IDs work together to enhance the credibility, visibility, and attribution of scholarly research. DOIs provide unique identifiers for individual research outputs, while ORCID IDs provide unique identifiers for researchers themselves. By linking the two, your scholarly works can be accurately attributed to you, facilitating better tracking of research impact and establishing reliable connections between researchers and their contributions. In the upcoming sections, we will explore the steps to connect your research software development with DOI and ORCID ID record.
DOIs and ORCIDs work together to enhance the credibility, visibility, and attribution of scholarly research. DOIs provide unique identifiers for individual research outputs, while ORCIDs provide unique identifiers for researchers themselves. By linking the two, your scholarly works can be accurately attributed to you, facilitating better tracking of research impact and establishing reliable connections between researchers and their contributions. In the upcoming section we will explore the steps to connect your research software development with DOI and ORCID persistent identifiers to create a research profile.

Check failure on line 10 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L10

[Vale.Spelling] Did you really mean 'DOIs'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'DOIs'?", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 10, "column": 1}}}, "severity": "ERROR"}

Check failure on line 10 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L10

[Vale.Spelling] Did you really mean 'ORCIDs'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'ORCIDs'?", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 10, "column": 10}}}, "severity": "ERROR"}

Check failure on line 10 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L10

[Vale.Spelling] Did you really mean 'DOIs'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'DOIs'?", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 10, "column": 110}}}, "severity": "ERROR"}

Check failure on line 10 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L10

[Vale.Spelling] Did you really mean 'ORCIDs'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'ORCIDs'?", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 10, "column": 181}}}, "severity": "ERROR"}

Check notice on line 10 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L10

[write-good.E-Prime] Try to avoid using 'be'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'be'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 10, "column": 288}}}, "severity": "INFO"}

Check warning on line 10 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L10

[Google.We] Try to avoid using first-person plural like 'we'.
Raw output
{"message": "[Google.We] Try to avoid using first-person plural like 'we'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 10, "column": 476}}}, "severity": "WARNING"}

Check warning on line 10 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L10

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 10, "column": 479}}}, "severity": "WARNING"}

Check notice on line 10 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L10

[Google.Acronyms] Spell out 'DOI', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'DOI', if it's unfamiliar to the audience.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 10, "column": 553}}}, "severity": "INFO"}

Check notice on line 10 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L10

[Google.Acronyms] Spell out 'ORCID', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'ORCID', if it's unfamiliar to the audience.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 10, "column": 561}}}, "severity": "INFO"}

### Generate DOI for Your Research Software
### Generate a DOI for Your Research Software

Check warning on line 12 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L12

[Google.Headings] 'Generate a DOI for Your Research Software' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Generate a DOI for Your Research Software' should use sentence-style capitalization.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 12, "column": 5}}}, "severity": "WARNING"}

Check notice on line 12 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L12

[Google.Acronyms] Spell out 'DOI', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'DOI', if it's unfamiliar to the audience.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 12, "column": 16}}}, "severity": "INFO"}

Assuming you have deposited and publish your software source code on GitHub with a license. Now you can index your software source code with DOI using [Zenodo.org](https://zenodo.org/). Zenodo is a free and open-access research data repository and publishing platform that facilitates the sharing, archiving, and dissemination of research outputs. It is an initiative developed and operated by CERN (European Organization for Nuclear Research) and is part of the European OpenAIRE project.
To generate a DOI for software, we will use the public and popular [Zenodo](https://about.zenodo.org/) repository. Zenodo is a free, open-access research data repository and publishing platform that facilitates the sharing, archiving and dissemination of research outputs. It is an initiative developed and operated by CERN (European Organization for Nuclear Research) and is part of the European OpenAIRE project.

Check notice on line 14 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L14

[Google.Acronyms] Spell out 'DOI', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'DOI', if it's unfamiliar to the audience.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 14, "column": 15}}}, "severity": "INFO"}

Check warning on line 14 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L14

[Google.We] Try to avoid using first-person plural like 'we'.
Raw output
{"message": "[Google.We] Try to avoid using first-person plural like 'we'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 14, "column": 33}}}, "severity": "WARNING"}

Check warning on line 14 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L14

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 14, "column": 36}}}, "severity": "WARNING"}

Check failure on line 14 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L14

[Vale.Spelling] Did you really mean 'Zenodo'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Zenodo'?", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 14, "column": 69}}}, "severity": "ERROR"}

Check failure on line 14 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L14

[Vale.Spelling] Did you really mean 'Zenodo'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Zenodo'?", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 14, "column": 116}}}, "severity": "ERROR"}

Check warning on line 14 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L14

[Google.OxfordComma] Use the Oxford comma in 'Zenodo is a free, open-access research data repository and publishing platform that facilitates the sharing, archiving and'.
Raw output
{"message": "[Google.OxfordComma] Use the Oxford comma in 'Zenodo is a free, open-access research data repository and publishing platform that facilitates the sharing, archiving and'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 14, "column": 116}}}, "severity": "WARNING"}

Check notice on line 14 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L14

[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 14, "column": 123}}}, "severity": "INFO"}

Check notice on line 14 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L14

[Google.Contractions] Use 'it's' instead of 'It is'.
Raw output
{"message": "[Google.Contractions] Use 'it's' instead of 'It is'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 14, "column": 274}}}, "severity": "INFO"}

Check warning on line 14 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L14

[write-good.TooWordy] 'It is' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'It is' is too wordy.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 14, "column": 274}}}, "severity": "WARNING"}

Check notice on line 14 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L14

[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 14, "column": 277}}}, "severity": "INFO"}

Check notice on line 14 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L14

[Google.Acronyms] Spell out 'CERN', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'CERN', if it's unfamiliar to the audience.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 14, "column": 320}}}, "severity": "INFO"}

Check notice on line 14 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L14

[Google.Parens] Use parentheses judiciously.
Raw output
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 14, "column": 325}}}, "severity": "INFO"}

First, create a Zenodo account, you may use a email & password authentication method or Single-Sign On with GitHub or ORCID ID.
In this example, we will demonstrate how to create a repository on Zenodo directly from your _public_ repository on GitHub. (You cannot create a DOI to a private repository.) Per your Software Management Plan, this repository should include your software license as well as licenses for any software libraries included.

Check warning on line 16 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L16

[Google.We] Try to avoid using first-person plural like 'we'.
Raw output
{"message": "[Google.We] Try to avoid using first-person plural like 'we'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 16, "column": 18}}}, "severity": "WARNING"}

Check warning on line 16 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L16

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 16, "column": 21}}}, "severity": "WARNING"}

Check warning on line 16 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L16

[write-good.TooWordy] 'demonstrate' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'demonstrate' is too wordy.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 16, "column": 26}}}, "severity": "WARNING"}

Check failure on line 16 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L16

[Vale.Spelling] Did you really mean 'Zenodo'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Zenodo'?", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 16, "column": 68}}}, "severity": "ERROR"}

Check notice on line 16 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L16

[Google.Parens] Use parentheses judiciously.
Raw output
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 16, "column": 125}}}, "severity": "INFO"}

Check notice on line 16 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L16

[Google.Contractions] Use 'can't' instead of 'cannot'.
Raw output
{"message": "[Google.Contractions] Use 'can't' instead of 'cannot'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 16, "column": 130}}}, "severity": "INFO"}

Check notice on line 16 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L16

[Google.Acronyms] Spell out 'DOI', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'DOI', if it's unfamiliar to the audience.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 16, "column": 146}}}, "severity": "INFO"}

It is worth noting here, again, that while GitHub is a good version control system for managing software versions, performing collaborative development, it is not considered a persistent repository for software. There are too many reaosons why a git repository might have its location or reference change. We use Zenodo in this example as such a persistent software repository, which is necessary for identifiers like DOIs to be persistent.

Check notice on line 18 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L18

[Google.Contractions] Use 'it's' instead of 'It is'.
Raw output
{"message": "[Google.Contractions] Use 'it's' instead of 'It is'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 18, "column": 1}}}, "severity": "INFO"}

Check warning on line 18 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L18

[write-good.TooWordy] 'It is' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'It is' is too wordy.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 18, "column": 1}}}, "severity": "WARNING"}

Check notice on line 18 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L18

[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 18, "column": 4}}}, "severity": "INFO"}

Check notice on line 18 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L18

[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 18, "column": 51}}}, "severity": "INFO"}

Check warning on line 18 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L18

[write-good.TooWordy] 'it is' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'it is' is too wordy.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 18, "column": 154}}}, "severity": "WARNING"}

Check notice on line 18 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L18

[Google.Contractions] Use 'it's' instead of 'it is'.
Raw output
{"message": "[Google.Contractions] Use 'it's' instead of 'it is'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 18, "column": 154}}}, "severity": "INFO"}

Check notice on line 18 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L18

[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 18, "column": 157}}}, "severity": "INFO"}

Check failure on line 18 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L18

[write-good.ThereIs] Don't start a sentence with 'There are'.
Raw output
{"message": "[write-good.ThereIs] Don't start a sentence with 'There are'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 18, "column": 213}}}, "severity": "ERROR"}

Check notice on line 18 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L18

[write-good.E-Prime] Try to avoid using 'are'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'are'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 18, "column": 219}}}, "severity": "INFO"}

Check failure on line 18 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L18

[Vale.Spelling] Did you really mean 'reaosons'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'reaosons'?", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 18, "column": 232}}}, "severity": "ERROR"}

Check warning on line 18 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L18

[Google.We] Try to avoid using first-person plural like 'We'.
Raw output
{"message": "[Google.We] Try to avoid using first-person plural like 'We'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 18, "column": 307}}}, "severity": "WARNING"}

Check failure on line 18 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L18

[Vale.Spelling] Did you really mean 'Zenodo'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Zenodo'?", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 18, "column": 314}}}, "severity": "ERROR"}

Check notice on line 18 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L18

[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 18, "column": 385}}}, "severity": "INFO"}

Check failure on line 18 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L18

[Vale.Spelling] Did you really mean 'DOIs'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'DOIs'?", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 18, "column": 419}}}, "severity": "ERROR"}

Check notice on line 18 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L18

[write-good.E-Prime] Try to avoid using 'be'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'be'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 18, "column": 427}}}, "severity": "INFO"}

### Steps to Generate a DOI for Your Research Software

Check warning on line 20 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L20

[Google.Headings] 'Steps to Generate a DOI for Your Research Software' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Steps to Generate a DOI for Your Research Software' should use sentence-style capitalization.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 20, "column": 5}}}, "severity": "WARNING"}

Check notice on line 20 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L20

[Google.Acronyms] Spell out 'DOI', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'DOI', if it's unfamiliar to the audience.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 20, "column": 25}}}, "severity": "INFO"}

First, create a Zenodo account. You may use an email + password authentication method or single sign-on with GitHub or ORCID accounts.

Check failure on line 22 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L22

[Vale.Spelling] Did you really mean 'Zenodo'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Zenodo'?", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 22, "column": 17}}}, "severity": "ERROR"}

Check warning on line 22 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L22

[Google.WordList] Use 'single sign-on' instead of 'sign-on'.
Raw output
{"message": "[Google.WordList] Use 'single sign-on' instead of 'sign-on'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 22, "column": 97}}}, "severity": "WARNING"}

Check notice on line 22 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L22

[Google.Acronyms] Spell out 'ORCID', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'ORCID', if it's unfamiliar to the audience.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 22, "column": 120}}}, "severity": "INFO"}

![zenodo-sso](assets/img/zenodo-sso.png)

Once you have created a Zenodo account, click the dropdown menu which contains your Zenodo registration email and select GitHub.
Once you have created and logged into your Zenodo account, click the drop-down menu (in the banner, top-right), which contains your Zenodo registration email, and select GitHub.

Check failure on line 26 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L26

[Vale.Spelling] Did you really mean 'Zenodo'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Zenodo'?", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 26, "column": 44}}}, "severity": "ERROR"}

Check notice on line 26 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L26

[Google.Parens] Use parentheses judiciously.
Raw output
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 26, "column": 85}}}, "severity": "INFO"}

Check failure on line 26 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L26

[Vale.Spelling] Did you really mean 'Zenodo'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Zenodo'?", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 26, "column": 133}}}, "severity": "ERROR"}

![zenodo-1](assets/img/zenodo-1.png)

Follow the instructions provided to link your GitHub account with Zenodo. And once you have linked your GitHub account with Zenodo. You will see all your public repositories from Zenodo side. Scroll to the repository you want to index and toggle the switch box next to it to turn on automatic preservation.
Follow the instructions provided to link your GitHub account with Zenodo. Once you have linked your GitHub account with Zenodo, you will see all your public repositories from the Zenodo side. In Zenodo, scroll to the repository you want to index and toggle the switch box next to it to turn on automatic preservation. In the screenshots below we demonstrate these actions on the software repository `quantum-stable-matching`.

Check failure on line 30 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L30

[Vale.Spelling] Did you really mean 'Zenodo'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Zenodo'?", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 30, "column": 67}}}, "severity": "ERROR"}

Check failure on line 30 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L30

[Vale.Spelling] Did you really mean 'Zenodo'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Zenodo'?", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 30, "column": 121}}}, "severity": "ERROR"}

Check warning on line 30 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L30

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 30, "column": 133}}}, "severity": "WARNING"}

Check failure on line 30 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L30

[Vale.Spelling] Did you really mean 'Zenodo'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Zenodo'?", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 30, "column": 180}}}, "severity": "ERROR"}

Check failure on line 30 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L30

[Vale.Spelling] Did you really mean 'Zenodo'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Zenodo'?", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 30, "column": 196}}}, "severity": "ERROR"}

Check warning on line 30 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L30

[Google.We] Try to avoid using first-person plural like 'we'.
Raw output
{"message": "[Google.We] Try to avoid using first-person plural like 'we'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 30, "column": 344}}}, "severity": "WARNING"}

Check warning on line 30 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L30

[write-good.TooWordy] 'demonstrate' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'demonstrate' is too wordy.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 30, "column": 347}}}, "severity": "WARNING"}

![zenodo-2](assets/img/zenodo-2.png)

Expand All @@ -31,15 +37,17 @@ Then go to the GitHub repository and [create a release](https://docs.github.com/
![zenodo-3](assets/img/zenodo-3.png)

It will take approximately 1 hour for Zenodo to generate a DOI and about a day for the DOI to be effective on [doi.org](https://www.doi.org/).
It will take approximately 1 hour for Zenodo to generate a DOI and about a day for the DOI to be effective on [doi.org](https://www.doi.org/) through their respective background automation processes.

Check warning on line 40 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L40

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 40, "column": 4}}}, "severity": "WARNING"}

Check failure on line 40 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L40

[Vale.Spelling] Did you really mean 'Zenodo'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Zenodo'?", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 40, "column": 39}}}, "severity": "ERROR"}

Check notice on line 40 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L40

[Google.Acronyms] Spell out 'DOI', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'DOI', if it's unfamiliar to the audience.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 40, "column": 60}}}, "severity": "INFO"}

Check notice on line 40 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L40

[Google.Acronyms] Spell out 'DOI', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'DOI', if it's unfamiliar to the audience.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 40, "column": 88}}}, "severity": "INFO"}

Check notice on line 40 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L40

[write-good.E-Prime] Try to avoid using 'be'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'be'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 40, "column": 95}}}, "severity": "INFO"}

![zenodo-4](assets/img/zenodo-4.png)

### Adding Your Research Software to Your ORCID ID Record
### Adding Your Research Software to Your ORCID Record

Check warning on line 44 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L44

[Google.Headings] 'Adding Your Research Software to Your ORCID Record' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Adding Your Research Software to Your ORCID Record' should use sentence-style capitalization.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 44, "column": 5}}}, "severity": "WARNING"}

Check notice on line 44 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L44

[Google.Acronyms] Spell out 'ORCID', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'ORCID', if it's unfamiliar to the audience.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 44, "column": 43}}}, "severity": "INFO"}

Now that you have a DOI for your research software project, it is time to add it to your ORCID ID record.
Now that you have a DOI for your research software project, it is time to add it to your ORCID profile.

Check notice on line 46 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L46

[Google.Acronyms] Spell out 'DOI', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'DOI', if it's unfamiliar to the audience.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 46, "column": 21}}}, "severity": "INFO"}

Check notice on line 46 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L46

[Google.Contractions] Use 'it's' instead of 'it is'.
Raw output
{"message": "[Google.Contractions] Use 'it's' instead of 'it is'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 46, "column": 61}}}, "severity": "INFO"}

Check warning on line 46 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L46

[write-good.TooWordy] 'it is' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'it is' is too wordy.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 46, "column": 61}}}, "severity": "WARNING"}

Check notice on line 46 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L46

[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 46, "column": 64}}}, "severity": "INFO"}

Check notice on line 46 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L46

[Google.Acronyms] Spell out 'ORCID', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'ORCID', if it's unfamiliar to the audience.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 46, "column": 90}}}, "severity": "INFO"}

Login your ORCID ID record. Go to "Works" and click the "Add" button. Select "Add DOI". Enter the DOI of your project and then click "Retrieve work details from DOI".
If you do not yet have an ORCID record, [Register on ORCID](https://orcid.org/register) to create one.

Check notice on line 48 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L48

[Google.Contractions] Use 'don't' instead of 'do not'.
Raw output
{"message": "[Google.Contractions] Use 'don't' instead of 'do not'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 48, "column": 8}}}, "severity": "INFO"}

Check notice on line 48 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L48

[Google.Acronyms] Spell out 'ORCID', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'ORCID', if it's unfamiliar to the audience.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 48, "column": 27}}}, "severity": "INFO"}

Check notice on line 48 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L48

[Google.Acronyms] Spell out 'ORCID', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'ORCID', if it's unfamiliar to the audience.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 48, "column": 54}}}, "severity": "INFO"}

Log in to your ORCID record. Go to "Works" and click the "Add" button. Select "Add DOI". Enter the DOI of your project and then click "Retrieve work details from DOI".

Check notice on line 50 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L50

[Google.Acronyms] Spell out 'ORCID', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'ORCID', if it's unfamiliar to the audience.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 50, "column": 16}}}, "severity": "INFO"}

Check failure on line 50 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L50

[Google.Quotes] Commas and periods go inside quotation marks.
Raw output
{"message": "[Google.Quotes] Commas and periods go inside quotation marks.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 50, "column": 79}}}, "severity": "ERROR"}

Check notice on line 50 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L50

[Google.Acronyms] Spell out 'DOI', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'DOI', if it's unfamiliar to the audience.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 50, "column": 84}}}, "severity": "INFO"}

Check notice on line 50 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L50

[Google.Acronyms] Spell out 'DOI', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'DOI', if it's unfamiliar to the audience.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 50, "column": 100}}}, "severity": "INFO"}

Check failure on line 50 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L50

[Google.Quotes] Commas and periods go inside quotation marks.
Raw output
{"message": "[Google.Quotes] Commas and periods go inside quotation marks.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 50, "column": 135}}}, "severity": "ERROR"}

Check notice on line 50 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L50

[Google.Acronyms] Spell out 'DOI', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'DOI', if it's unfamiliar to the audience.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 50, "column": 163}}}, "severity": "INFO"}

![orcid-1](assets/img/orcid-1.png)
![orcid-2](assets/img/orcid-2.png)
Expand All @@ -48,6 +56,8 @@ Edit the work details and the click "Add this work to your ORCID record".

![orcid-3](assets/img/orcid-3.png)

You will see the new entry in the ORCID ID work record.
You will see the new entry in the ORCID work record.

Check warning on line 59 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L59

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 59, "column": 5}}}, "severity": "WARNING"}

Check notice on line 59 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L59

[Google.Acronyms] Spell out 'ORCID', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'ORCID', if it's unfamiliar to the audience.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 59, "column": 35}}}, "severity": "INFO"}

![orcid-4](assets/img/orcid-4.png)

At this point you will have deposited a persistent copy of your software release on Zenodo, created a DOI for this software project and release, and linked this work with your ORCID profile.

Check warning on line 63 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L63

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 63, "column": 19}}}, "severity": "WARNING"}

Check failure on line 63 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L63

[Vale.Spelling] Did you really mean 'Zenodo'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Zenodo'?", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 63, "column": 85}}}, "severity": "ERROR"}

Check notice on line 63 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L63

[Google.Acronyms] Spell out 'DOI', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'DOI', if it's unfamiliar to the audience.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 63, "column": 103}}}, "severity": "INFO"}

Check notice on line 63 in rs-impact/portfolio.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/portfolio.md#L63

[Google.Acronyms] Spell out 'ORCID', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'ORCID', if it's unfamiliar to the audience.", "location": {"path": "rs-impact/portfolio.md", "range": {"start": {"line": 63, "column": 177}}}, "severity": "INFO"}

0 comments on commit 2a1eab3

Please sign in to comment.