Skip to content

Commit

Permalink
updated 'website' and 'open source'
Browse files Browse the repository at this point in the history
  • Loading branch information
hykelvinlee42 committed Jul 31, 2024
1 parent 58c4941 commit 81aa339
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ By the end of this learning module, readers will be able to:
- Develop and manage software to comply with FAIR4RS principles

Check warning on line 21 in index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] index.md#L21

[write-good.TooWordy] 'comply with' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'comply with' is too wordy.", "location": {"path": "index.md", "range": {"start": {"line": 21, "column": 34}}}, "severity": "WARNING"}
- Understand the principles and signifcance of minimal computing in promoting software preservation and reuse

Check failure on line 22 in index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] index.md#L22

[Vale.Spelling] Did you really mean 'signifcance'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'signifcance'?", "location": {"path": "index.md", "range": {"start": {"line": 22, "column": 33}}}, "severity": "ERROR"}
- Develop and deploy minimal computing sites using Jekyll and GitHub Pages, as an example
- Understand the interconnection between open-source research software and research impact through the use of persistent identifiers with practical guidance
- Understand the interconnection between open source research software and research impact through the use of persistent identifiers with practical guidance
2 changes: 1 addition & 1 deletion minimal-computing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ _Image retrieved from [https://jntry.work/minimalcomputing/](https://jntry.work/

Minimal computing refers to a set of practices aimed at simplifying digital technologies and workflows to reduce computation resource consumption and dependency on complex software structures. As a benefit, minimal computing software emphasizes long-term maintenance and results in sustainable and durable software. Minimal computing is a design that implements the principles of reusable computer code and software.

Check notice on line 14 in minimal-computing/index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/index.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": "minimal-computing/index.md", "range": {"start": {"line": 14, "column": 335}}}, "severity": "INFO"}

Throughout this learning module, you will explore the principles and practices of minimal computing, a methodology focused on simplicity, accessibility and sustainability in digital projects. We will demonstrate this design when building web sites, using the publicly available tool Jekyll for building web sites, and GitHub Pages to host these generate web sites. Using GitHub as part of the technology stack directly supports reproducible software by being free, publicly-accessible and integrated with the GitHub cloud version control system.
Throughout this learning module, you will explore the principles and practices of minimal computing, a methodology focused on simplicity, accessibility and sustainability in digital projects. We will demonstrate this design when building websites, using the publicly available tool Jekyll for building websites, and GitHub Pages to host these generate websites. Using GitHub as part of the technology stack directly supports reproducible software by being free, publicly-accessible and integrated with the GitHub cloud version control system.

Check warning on line 16 in minimal-computing/index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/index.md#L16

[Google.OxfordComma] Use the Oxford comma in 'Throughout this learning module, you will explore the principles and practices of minimal computing, a methodology focused on simplicity, accessibility and'.
Raw output
{"message": "[Google.OxfordComma] Use the Oxford comma in 'Throughout this learning module, you will explore the principles and practices of minimal computing, a methodology focused on simplicity, accessibility and'.", "location": {"path": "minimal-computing/index.md", "range": {"start": {"line": 16, "column": 1}}}, "severity": "WARNING"}

Check warning on line 16 in minimal-computing/index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/index.md#L16

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "minimal-computing/index.md", "range": {"start": {"line": 16, "column": 38}}}, "severity": "WARNING"}

Check warning on line 16 in minimal-computing/index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/index.md#L16

[write-good.TooWordy] 'methodology' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'methodology' is too wordy.", "location": {"path": "minimal-computing/index.md", "range": {"start": {"line": 16, "column": 104}}}, "severity": "WARNING"}

Check warning on line 16 in minimal-computing/index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/index.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": "minimal-computing/index.md", "range": {"start": {"line": 16, "column": 193}}}, "severity": "WARNING"}

Check warning on line 16 in minimal-computing/index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/index.md#L16

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "minimal-computing/index.md", "range": {"start": {"line": 16, "column": 196}}}, "severity": "WARNING"}

Check warning on line 16 in minimal-computing/index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/index.md#L16

[write-good.TooWordy] 'demonstrate' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'demonstrate' is too wordy.", "location": {"path": "minimal-computing/index.md", "range": {"start": {"line": 16, "column": 201}}}, "severity": "WARNING"}

Check notice on line 16 in minimal-computing/index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/index.md#L16

[write-good.E-Prime] Try to avoid using 'being'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'being'.", "location": {"path": "minimal-computing/index.md", "range": {"start": {"line": 16, "column": 451}}}, "severity": "INFO"}

Check failure on line 16 in minimal-computing/index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/index.md#L16

[Google.LyHyphens] 'publicly-accessible' doesn't need a hyphen.
Raw output
{"message": "[Google.LyHyphens] 'publicly-accessible' doesn't need a hyphen.", "location": {"path": "minimal-computing/index.md", "range": {"start": {"line": 16, "column": 463}}}, "severity": "ERROR"}

1. **Introduction to Minimal Computing**: This section introduces the concept of minimal computing, discussing its advantages and disadvantages.
2. **Building a Minimal Computing Site**: Learn how to create a minimal computing site from scratch using Jekyll.
Expand Down
6 changes: 3 additions & 3 deletions minimal-computing/minimal-site.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ nav_order: 2
---

## Building a minimal computing site
Web sites are a common type of software developed for research. With modern web browsers, HTML5 and minimal computing design, much of the complexity of web sites can be removed, supporting the FAIR principles of reproducible software. It also results in a clean, modern design.
Websites are a common type of software developed for research. With modern web browsers, HTML5 and minimal computing design, much of the complexity of websites can be removed, supporting the FAIR principles of reproducible software. It also results in a clean, modern design.

Check notice on line 9 in minimal-computing/minimal-site.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/minimal-site.md#L9

[write-good.E-Prime] Try to avoid using 'are'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'are'.", "location": {"path": "minimal-computing/minimal-site.md", "range": {"start": {"line": 9, "column": 10}}}, "severity": "INFO"}

Check warning on line 9 in minimal-computing/minimal-site.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/minimal-site.md#L9

[write-good.TooWordy] 'type of' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'type of' is too wordy.", "location": {"path": "minimal-computing/minimal-site.md", "range": {"start": {"line": 9, "column": 23}}}, "severity": "WARNING"}

Check warning on line 9 in minimal-computing/minimal-site.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/minimal-site.md#L9

[Google.OxfordComma] Use the Oxford comma in 'With modern web browsers, HTML5 and'.
Raw output
{"message": "[Google.OxfordComma] Use the Oxford comma in 'With modern web browsers, HTML5 and'.", "location": {"path": "minimal-computing/minimal-site.md", "range": {"start": {"line": 9, "column": 64}}}, "severity": "WARNING"}

Check notice on line 9 in minimal-computing/minimal-site.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/minimal-site.md#L9

[write-good.E-Prime] Try to avoid using 'be'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'be'.", "location": {"path": "minimal-computing/minimal-site.md", "range": {"start": {"line": 9, "column": 165}}}, "severity": "INFO"}

Check notice on line 9 in minimal-computing/minimal-site.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/minimal-site.md#L9

[Google.Passive] In general, use active voice instead of passive voice ('be removed').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('be removed').", "location": {"path": "minimal-computing/minimal-site.md", "range": {"start": {"line": 9, "column": 165}}}, "severity": "INFO"}

Check warning on line 9 in minimal-computing/minimal-site.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/minimal-site.md#L9

[write-good.Passive] 'be removed' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'be removed' may be passive voice. Use active voice if you can.", "location": {"path": "minimal-computing/minimal-site.md", "range": {"start": {"line": 9, "column": 165}}}, "severity": "WARNING"}

Check notice on line 9 in minimal-computing/minimal-site.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/minimal-site.md#L9

[Google.Acronyms] Spell out 'FAIR', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'FAIR', if it's unfamiliar to the audience.", "location": {"path": "minimal-computing/minimal-site.md", "range": {"start": {"line": 9, "column": 192}}}, "severity": "INFO"}

These next sections detail how to build a minimal computing web site using available open-source technologies.
These next sections detail how to build a minimal computing website using available open source technologies.

We will be demonstrating this development using Jekyll, a free open-source static site generator that is built and runs on the Ruby programming language. It is a popular choice for building a minimal computing site due to its simplicity, flexibility, and efficiency.
We will be demonstrating this development using Jekyll, a free open source static site generator that is built and runs on the Ruby programming language. It is a popular choice for building a minimal computing site due to its simplicity, flexibility, and efficiency.

Check warning on line 13 in minimal-computing/minimal-site.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/minimal-site.md#L13

[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": "minimal-computing/minimal-site.md", "range": {"start": {"line": 13, "column": 1}}}, "severity": "WARNING"}

Check warning on line 13 in minimal-computing/minimal-site.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/minimal-site.md#L13

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "minimal-computing/minimal-site.md", "range": {"start": {"line": 13, "column": 4}}}, "severity": "WARNING"}

Check notice on line 13 in minimal-computing/minimal-site.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/minimal-site.md#L13

[write-good.E-Prime] Try to avoid using 'be'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'be'.", "location": {"path": "minimal-computing/minimal-site.md", "range": {"start": {"line": 13, "column": 9}}}, "severity": "INFO"}

Check notice on line 13 in minimal-computing/minimal-site.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/minimal-site.md#L13

[Google.Contractions] Use 'that's' instead of 'that is'.
Raw output
{"message": "[Google.Contractions] Use 'that's' instead of 'that is'.", "location": {"path": "minimal-computing/minimal-site.md", "range": {"start": {"line": 13, "column": 98}}}, "severity": "INFO"}

Check warning on line 13 in minimal-computing/minimal-site.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/minimal-site.md#L13

[write-good.Passive] 'is built' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'is built' may be passive voice. Use active voice if you can.", "location": {"path": "minimal-computing/minimal-site.md", "range": {"start": {"line": 13, "column": 103}}}, "severity": "WARNING"}

Check notice on line 13 in minimal-computing/minimal-site.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/minimal-site.md#L13

[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "minimal-computing/minimal-site.md", "range": {"start": {"line": 13, "column": 103}}}, "severity": "INFO"}

Check notice on line 13 in minimal-computing/minimal-site.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/minimal-site.md#L13

[Google.Passive] In general, use active voice instead of passive voice ('is built').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is built').", "location": {"path": "minimal-computing/minimal-site.md", "range": {"start": {"line": 13, "column": 103}}}, "severity": "INFO"}

Check notice on line 13 in minimal-computing/minimal-site.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/minimal-site.md#L13

[Google.Contractions] Use 'it's' instead of 'It is'.
Raw output
{"message": "[Google.Contractions] Use 'it's' instead of 'It is'.", "location": {"path": "minimal-computing/minimal-site.md", "range": {"start": {"line": 13, "column": 155}}}, "severity": "INFO"}

Check warning on line 13 in minimal-computing/minimal-site.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/minimal-site.md#L13

[write-good.TooWordy] 'It is' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'It is' is too wordy.", "location": {"path": "minimal-computing/minimal-site.md", "range": {"start": {"line": 13, "column": 155}}}, "severity": "WARNING"}

### Prerequisites
Jekyll requires the following:
Expand Down
2 changes: 1 addition & 1 deletion minimal-computing/summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ nav_order: 13

## Summary

Throughout this module we covered the fundamentals of Minimal Computing and emphasized its importance in keeping our digital products simple and accessible. We explored in detail how to create and customize a Minimal Computing site that uses the Minima Jekyll theme and how to host it on GitHub Pages. This work provides the basis to create and host minimal computing web sites, and understand the importance of minimal computing for research software.
Throughout this module we covered the fundamentals of Minimal Computing and emphasized its importance in keeping our digital products simple and accessible. We explored in detail how to create and customize a Minimal Computing site that uses the Minima Jekyll theme and how to host it on GitHub Pages. This work provides the basis to create and host minimal computing websites, and understand the importance of minimal computing for research software.

Check warning on line 10 in minimal-computing/summary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/summary.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": "minimal-computing/summary.md", "range": {"start": {"line": 10, "column": 24}}}, "severity": "WARNING"}

Check warning on line 10 in minimal-computing/summary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/summary.md#L10

[Google.We] Try to avoid using first-person plural like 'our'.
Raw output
{"message": "[Google.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "minimal-computing/summary.md", "range": {"start": {"line": 10, "column": 114}}}, "severity": "WARNING"}

Check warning on line 10 in minimal-computing/summary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/summary.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": "minimal-computing/summary.md", "range": {"start": {"line": 10, "column": 158}}}, "severity": "WARNING"}

### Further Readings

Check warning on line 12 in minimal-computing/summary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/summary.md#L12

[Google.Headings] 'Further Readings' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Further Readings' should use sentence-style capitalization.", "location": {"path": "minimal-computing/summary.md", "range": {"start": {"line": 12, "column": 5}}}, "severity": "WARNING"}

Expand Down
8 changes: 4 additions & 4 deletions reproducibility/reproducible-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ def baz(z=42):
return bar(z, 916)
```

Aside from the software design perspective, employing middleware or integration platforms (e.g. Apache Kafka, an open-source distributed event streaming platform) that provide standardized interfaces and tools for connecting disparate software systems help achieving software interoperability. These platforms act as intermediaries, enabling communication, data transformation, and message routing between different applications.
Aside from the software design perspective, employing middleware or integration platforms (e.g. Apache Kafka, an open source distributed event streaming platform) that provide standardized interfaces and tools for connecting disparate software systems help achieving software interoperability. These platforms act as intermediaries, enabling communication, data transformation, and message routing between different applications.

## Use of Non-proprietary and Lossless Formats

Expand Down Expand Up @@ -91,13 +91,13 @@ A source code repository management service provides a centralized location for

You may also add and host your software to a software package registry. A software package registry is a centralized repository, cloud service or database that hosts and manages software packages. It serves as a platform for developers and users to discover, download, install, and manage software libraries, frameworks, tools or applications. Software package registries provide a standardized way to distribute and share software components across different programming languages and platforms. The package installer for Python mentioned above, `pip`, download packages from a software package registry called [PyPI (Python Package Index)](https://pypi.org/).

There also exist container image repositories, which are centralized locations or cloud services that store and manage container images. These repositories are useful for distributing container images, but are not currently intended as a preservation system. Docker offers a service called [Docker Hub](https://hub.docker.com/), which is an open-source registry to [store](https://docs.docker.com/engine/reference/commandline/push/) container images and allows others to download and run your container images.
There also exist container image repositories, which are centralized locations or cloud services that store and manage container images. These repositories are useful for distributing container images, but are not currently intended as a preservation system. Docker offers a service called [Docker Hub](https://hub.docker.com/), which is an open source registry to [store](https://docs.docker.com/engine/reference/commandline/push/) container images and allows others to download and run your container images.

You may also consider adding your software to the [Research Software Directory](https://research-software-directory.org/). The Netherlands eScience Center developed the open-source research software directory to promote visibility, findability, impact and reuse of research software. The [Digital Research Alliance of Canada](https://alliancecan.ca/en/services/research-software/canadian-research-software-platforms) assists Canadian researchers to add their active research software, which meet the following requirements, to the Research Software Directory.
You may also consider adding your software to the [Research Software Directory](https://research-software-directory.org/). The Netherlands eScience Center developed the open source research software directory to promote visibility, findability, impact and reuse of research software. The [Digital Research Alliance of Canada](https://alliancecan.ca/en/services/research-software/canadian-research-software-platforms) assists Canadian researchers to add their active research software, which meet the following requirements, to the Research Software Directory.

> 1. Is a Canadian Research Software (i.e., owned/led by a Canadian institution).
> 2. Is a platform/science gateway, or a component of software that can be deployed independently.
> 3. Is available via an open source license, or emerged from a publicly funded open-source project.
> 3. Is available via an open source license, or emerged from a publicly funded open source project.
> 4. Is currently maintained.
> 5. It fits with the promotional mandate of the Alliance.
Expand Down
2 changes: 1 addition & 1 deletion rs-impact/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ has_toc: true

Open scholarship, also known as open science, refers to the movement towards making research and scholarly work openly accessible, transparent and reusable. Open scholarship encompasses principles and practices aimed at promoting collaboration, transparency and the sharing of knowledge in the academic community. While research impact refers to the influence and effects that research activities have on various stakeholders, including academia, industry, policy-makers, society, and the broader public. Open scholarship expands the influence of research on the advancement of knowledge within academic disciplines. It is often measured through citations in peer-reviewed journals and the recognition of research within the scholarly community.

Check warning on line 11 in rs-impact/index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/index.md#L11

[Google.OxfordComma] Use the Oxford comma in 'Open scholarship, also known as open science, refers to the movement towards making research and scholarly work openly accessible, transparent and'.
Raw output
{"message": "[Google.OxfordComma] Use the Oxford comma in 'Open scholarship, also known as open science, refers to the movement towards making research and scholarly work openly accessible, transparent and'.", "location": {"path": "rs-impact/index.md", "range": {"start": {"line": 11, "column": 1}}}, "severity": "WARNING"}

Check warning on line 11 in rs-impact/index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/index.md#L11

[Google.OxfordComma] Use the Oxford comma in 'Open scholarship encompasses principles and practices aimed at promoting collaboration, transparency and'.
Raw output
{"message": "[Google.OxfordComma] Use the Oxford comma in 'Open scholarship encompasses principles and practices aimed at promoting collaboration, transparency and'.", "location": {"path": "rs-impact/index.md", "range": {"start": {"line": 11, "column": 158}}}, "severity": "WARNING"}

Check warning on line 11 in rs-impact/index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/index.md#L11

[write-good.Weasel] 'various' is a weasel word!
Raw output
{"message": "[write-good.Weasel] 'various' is a weasel word!", "location": {"path": "rs-impact/index.md", "range": {"start": {"line": 11, "column": 406}}}, "severity": "WARNING"}

Check notice on line 11 in rs-impact/index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/index.md#L11

[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/index.md", "range": {"start": {"line": 11, "column": 618}}}, "severity": "INFO"}

Check warning on line 11 in rs-impact/index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/index.md#L11

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

Check notice on line 11 in rs-impact/index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/index.md#L11

[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/index.md", "range": {"start": {"line": 11, "column": 621}}}, "severity": "INFO"}

One of the key components of open scholarship is open source software. Open-source software is software where the source code is freely available, allowing others to view, modify and distribute the code. As a result of these aspects, open-source software often play a significant role in research software development.
One of the key components of open scholarship is open source software. Open source software is software where the source code is freely available, allowing others to view, modify and distribute the code. As a result of these aspects, open source software often play a significant role in research software development.

Check notice on line 13 in rs-impact/index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/index.md#L13

[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/index.md", "range": {"start": {"line": 13, "column": 47}}}, "severity": "INFO"}

Check warning on line 13 in rs-impact/index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/index.md#L13

[Google.OxfordComma] Use the Oxford comma in 'Open source software is software where the source code is freely available, allowing others to view, modify and'.
Raw output
{"message": "[Google.OxfordComma] Use the Oxford comma in 'Open source software is software where the source code is freely available, allowing others to view, modify and'.", "location": {"path": "rs-impact/index.md", "range": {"start": {"line": 13, "column": 72}}}, "severity": "WARNING"}

Check notice on line 13 in rs-impact/index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/index.md#L13

[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/index.md", "range": {"start": {"line": 13, "column": 93}}}, "severity": "INFO"}

Check notice on line 13 in rs-impact/index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/index.md#L13

[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/index.md", "range": {"start": {"line": 13, "column": 127}}}, "severity": "INFO"}

Check warning on line 13 in rs-impact/index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] rs-impact/index.md#L13

[write-good.TooWordy] 'modify' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'modify' is too wordy.", "location": {"path": "rs-impact/index.md", "range": {"start": {"line": 13, "column": 173}}}, "severity": "WARNING"}
4 changes: 2 additions & 2 deletions smp/licensing.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Research software should be developed and used in a way that promotes inclusivit

# Licensing & Legal Compliance

Check warning on line 20 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.md#L20

[Google.Headings] 'Licensing & Legal Compliance' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Licensing \u0026 Legal Compliance' should use sentence-style capitalization.", "location": {"path": "smp/licensing.md", "range": {"start": {"line": 20, "column": 3}}}, "severity": "WARNING"}

> **DISCLAIMER**: The following content is intended to highlight resources which may be useful to those developing open-source research software. This content is for informational purposes only. It is **NOT** legal advice. McMaster University and McMaster Research Software Development Team are not responsible for the content referenced in this guide, nor any and all costs, claims, losses, damages, expenses which may result through the application of this information. Be sure to contact a professional for legal advice.
> **DISCLAIMER**: The following content is intended to highlight resources which may be useful to those developing open source research software. This content is for informational purposes only. It is **NOT** legal advice. McMaster University and McMaster Research Software Development Team are not responsible for the content referenced in this guide, nor any and all costs, claims, losses, damages, expenses which may result through the application of this information. Be sure to contact a professional for legal advice.

Check warning on line 22 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.md#L22

[write-good.Passive] 'is intended' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'is intended' may be passive voice. Use active voice if you can.", "location": {"path": "smp/licensing.md", "range": {"start": {"line": 22, "column": 41}}}, "severity": "WARNING"}

Check notice on line 22 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.md#L22

[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "smp/licensing.md", "range": {"start": {"line": 22, "column": 41}}}, "severity": "INFO"}

Check notice on line 22 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.md#L22

[Google.Passive] In general, use active voice instead of passive voice ('is intended').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is intended').", "location": {"path": "smp/licensing.md", "range": {"start": {"line": 22, "column": 41}}}, "severity": "INFO"}

Check notice on line 22 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.md#L22

[write-good.E-Prime] Try to avoid using 'be'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'be'.", "location": {"path": "smp/licensing.md", "range": {"start": {"line": 22, "column": 86}}}, "severity": "INFO"}

Check notice on line 22 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.md#L22

[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "smp/licensing.md", "range": {"start": {"line": 22, "column": 160}}}, "severity": "INFO"}

Check notice on line 22 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.md#L22

[Google.Contractions] Use 'it's' instead of 'It is'.
Raw output
{"message": "[Google.Contractions] Use 'it's' instead of 'It is'.", "location": {"path": "smp/licensing.md", "range": {"start": {"line": 22, "column": 196}}}, "severity": "INFO"}

Check warning on line 22 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.md#L22

[write-good.TooWordy] 'It is' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'It is' is too wordy.", "location": {"path": "smp/licensing.md", "range": {"start": {"line": 22, "column": 196}}}, "severity": "WARNING"}

Check notice on line 22 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.md#L22

[Google.Acronyms] Spell out 'NOT', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'NOT', if it's unfamiliar to the audience.", "location": {"path": "smp/licensing.md", "range": {"start": {"line": 22, "column": 204}}}, "severity": "INFO"}

Check notice on line 22 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.md#L22

[write-good.E-Prime] Try to avoid using 'are'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'are'.", "location": {"path": "smp/licensing.md", "range": {"start": {"line": 22, "column": 292}}}, "severity": "INFO"}

Check notice on line 22 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.md#L22

[Google.Contractions] Use 'aren't' instead of 'are not'.
Raw output
{"message": "[Google.Contractions] Use 'aren't' instead of 'are not'.", "location": {"path": "smp/licensing.md", "range": {"start": {"line": 22, "column": 292}}}, "severity": "INFO"}

Check warning on line 22 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.md#L22

[Google.WordList] Use 'app' instead of 'application'.
Raw output
{"message": "[Google.WordList] Use 'app' instead of 'application'.", "location": {"path": "smp/licensing.md", "range": {"start": {"line": 22, "column": 440}}}, "severity": "WARNING"}

Check notice on line 22 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.md#L22

[write-good.E-Prime] Try to avoid using 'Be'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'Be'.", "location": {"path": "smp/licensing.md", "range": {"start": {"line": 22, "column": 473}}}, "severity": "INFO"}
It is encouraged to assign an appropriate license for your research software project. When choosing a license, consider the following:

Check warning on line 24 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.md#L24

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

Check notice on line 24 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.md#L24

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

Check notice on line 24 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.md#L24

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

Check warning on line 24 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.md#L24

[write-good.Passive] 'is encouraged' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'is encouraged' may be passive voice. Use active voice if you can.", "location": {"path": "smp/licensing.md", "range": {"start": {"line": 24, "column": 4}}}, "severity": "WARNING"}

Check notice on line 24 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.md#L24

[Google.Passive] In general, use active voice instead of passive voice ('is encouraged').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is encouraged').", "location": {"path": "smp/licensing.md", "range": {"start": {"line": 24, "column": 4}}}, "severity": "INFO"}

Expand All @@ -39,4 +39,4 @@ Should I share my research data and software source code using the same Creative

> Unlike software-specific licenses, CC [Creative Commons] licenses do not contain specific terms about the distribution of source code, which is often important to ensuring the free reuse and modifiability of software. Many software licenses also address patent rights, which are important to software but may not be applicable to other copyrightable works. Additionally, our licenses are currently not compatible with the major software licenses, so it would be difficult to integrate CC [Creative Commons] -licensed work with other free software. Existing software licenses were designed specifically for use with software and offer a similar set of rights to the Creative Commons licenses.

Check notice on line 40 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.md#L40

[Google.Contractions] Use 'don't' instead of 'do not'.
Raw output
{"message": "[Google.Contractions] Use 'don't' instead of 'do not'.", "location": {"path": "smp/licensing.md", "range": {"start": {"line": 40, "column": 69}}}, "severity": "INFO"}

Check notice on line 40 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.md#L40

[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "smp/licensing.md", "range": {"start": {"line": 40, "column": 144}}}, "severity": "INFO"}

Check failure on line 40 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.md#L40

[Vale.Spelling] Did you really mean 'modifiability'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'modifiability'?", "location": {"path": "smp/licensing.md", "range": {"start": {"line": 40, "column": 194}}}, "severity": "ERROR"}

Check notice on line 40 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.md#L40

[write-good.E-Prime] Try to avoid using 'are'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'are'.", "location": {"path": "smp/licensing.md", "range": {"start": {"line": 40, "column": 278}}}, "severity": "INFO"}

Check notice on line 40 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.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": "smp/licensing.md", "range": {"start": {"line": 40, "column": 316}}}, "severity": "INFO"}

Check warning on line 40 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.md#L40

[Google.We] Try to avoid using first-person plural like 'our'.
Raw output
{"message": "[Google.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "smp/licensing.md", "range": {"start": {"line": 40, "column": 374}}}, "severity": "WARNING"}

Check notice on line 40 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.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": "smp/licensing.md", "range": {"start": {"line": 40, "column": 462}}}, "severity": "INFO"}

Check warning on line 40 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.md#L40

[write-good.Passive] 'were designed' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'were designed' may be passive voice. Use active voice if you can.", "location": {"path": "smp/licensing.md", "range": {"start": {"line": 40, "column": 578}}}, "severity": "WARNING"}

Check notice on line 40 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.md#L40

[write-good.E-Prime] Try to avoid using 'were'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'were'.", "location": {"path": "smp/licensing.md", "range": {"start": {"line": 40, "column": 578}}}, "severity": "INFO"}

Check notice on line 40 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.md#L40

[Google.Passive] In general, use active voice instead of passive voice ('were designed').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('were designed').", "location": {"path": "smp/licensing.md", "range": {"start": {"line": 40, "column": 578}}}, "severity": "INFO"}
Ethical considerations extend to intellectual property and licensing in research software development. Developers should respect copyright, properly attribute existing software components, and consider open-source licensing when appropriate. These practices help ensure the fair, responsible and legal use of intellectual property.
Ethical considerations extend to intellectual property and licensing in research software development. Developers should respect copyright, properly attribute existing software components, and consider open source licensing when appropriate. These practices help ensure the fair, responsible and legal use of intellectual property.

Check warning on line 42 in smp/licensing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] smp/licensing.md#L42

[Google.OxfordComma] Use the Oxford comma in 'These practices help ensure the fair, responsible and'.
Raw output
{"message": "[Google.OxfordComma] Use the Oxford comma in 'These practices help ensure the fair, responsible and'.", "location": {"path": "smp/licensing.md", "range": {"start": {"line": 42, "column": 243}}}, "severity": "WARNING"}

0 comments on commit 81aa339

Please sign in to comment.