Skip to content

Commit

Permalink
fixed punctuation
Browse files Browse the repository at this point in the history
  • Loading branch information
hykelvinlee42 committed Jul 31, 2024
1 parent 81aa339 commit 929f34a
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 20 deletions.
12 changes: 6 additions & 6 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ This learning module intends to provide guidance on how to prepare for and impro

By the end of this learning module, readers will be able to:

Check warning on line 17 in index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] index.md#L17

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "index.md", "range": {"start": {"line": 17, "column": 45}}}, "severity": "WARNING"}

Check notice on line 17 in index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] index.md#L17

[write-good.E-Prime] Try to avoid using 'be'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'be'.", "location": {"path": "index.md", "range": {"start": {"line": 17, "column": 50}}}, "severity": "INFO"}

- Have a high-level understanding of FAIR principles in a research software context
- Consider a sustainable research software planning with the help of a software management plan
- Develop and manage software to comply with FAIR4RS principles
- Understand the principles and signifcance of minimal computing in promoting software preservation and reuse
- 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
- Have a high-level understanding of FAIR principles in a research software context.

Check notice on line 19 in index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] index.md#L19

[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": "index.md", "range": {"start": {"line": 19, "column": 38}}}, "severity": "INFO"}
- Consider a sustainable research software planning with the help of a software management plan.
- 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.
13 changes: 7 additions & 6 deletions minimal-computing/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,11 @@ parent: Minimal Computing
nav_order: 12
---

## Host minimal computing site on GitHub pages
# Host minimal computing site on GitHub pages

Jekyll can be used to generate web pages for a variety of web hosting tools. Here we describe how to host these Jekyll pages with GitHub Pages.

Check notice on line 10 in minimal-computing/deployment.md

View workflow job for this annotation

GitHub Actions / vale

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

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

Check notice on line 10 in minimal-computing/deployment.md

View workflow job for this annotation

GitHub Actions / vale

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

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

View workflow job for this annotation

GitHub Actions / vale

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

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

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

View workflow job for this annotation

GitHub Actions / vale

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

### A. Creating a repository on GitHub
## A. Creating a repository on GitHub

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

View workflow job for this annotation

GitHub Actions / vale

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

[Google.Headings] 'A. Creating a repository on GitHub' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'A. Creating a repository on GitHub' should use sentence-style capitalization.", "location": {"path": "minimal-computing/deployment.md", "range": {"start": {"line": 12, "column": 4}}}, "severity": "WARNING"}
1. Login to GitHub.
2. From the menu go to “Your repositories.”
3. Click on “New” button to create a new repository.
Expand All @@ -17,13 +18,13 @@ Jekyll can be used to generate web pages for a variety of web hosting tools. Her
6. Check the checkbox to add a README file.
7. Click on “Create repository” button.

### B. Uploading Files to the repository
## B. Uploading Files to the repository

Check warning on line 21 in minimal-computing/deployment.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/deployment.md#L21

[Google.Headings] 'B. Uploading Files to the repository' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'B. Uploading Files to the repository' should use sentence-style capitalization.", "location": {"path": "minimal-computing/deployment.md", "range": {"start": {"line": 21, "column": 4}}}, "severity": "WARNING"}

1. On the new repository main page click on “add file” button and select “Upload files” option.

Check warning on line 23 in minimal-computing/deployment.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/deployment.md#L23

[Google.WordList] Use 'click' or 'click in' instead of 'click on'.
Raw output
{"message": "[Google.WordList] Use 'click' or 'click in' instead of 'click on'.", "location": {"path": "minimal-computing/deployment.md", "range": {"start": {"line": 23, "column": 36}}}, "severity": "WARNING"}
2. Upload all the files that are in the “minima-site” folder.

Check notice on line 24 in minimal-computing/deployment.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/deployment.md#L24

[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/deployment.md", "range": {"start": {"line": 24, "column": 30}}}, "severity": "INFO"}
3. Click “Commit changes” button.

### C. Edit the _config.yml file
## C. Edit the `_config.yml` file
1. Open `_config.yml` file.
2. Click on the pencil edit icon in the corner to start editing the file.
3. Edit the value of the baseurl to add the sub path of your site. For example,

Check failure on line 30 in minimal-computing/deployment.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/deployment.md#L30

[Vale.Spelling] Did you really mean 'baseurl'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'baseurl'?", "location": {"path": "minimal-computing/deployment.md", "range": {"start": {"line": 30, "column": 26}}}, "severity": "ERROR"}
Expand All @@ -34,10 +35,10 @@ baseurl: "/minima-template".
```yaml
url: "https://example.github.io"
```
5. Click on “commit changes” button
5. Click on “commit changes” button.
6. Add a proper message to explain your changes. Then Click on “Commit changes” button.
### D. Deploy the Site
## D. Deploy the Site

Check warning on line 41 in minimal-computing/deployment.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/deployment.md#L41

[Google.Headings] 'D. Deploy the Site' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'D. Deploy the Site' should use sentence-style capitalization.", "location": {"path": "minimal-computing/deployment.md", "range": {"start": {"line": 41, "column": 4}}}, "severity": "WARNING"}
1. Navigate to “Settings.”
2. Go to the “Pages” tab.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ For example:

![locate_theme](assets/img/locate_theme.png)

Check failure on line 49 in minimal-computing/jekyll-customization/customize-minima-theme.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/jekyll-customization/customize-minima-theme.md#L49

[Vale.Spelling] Did you really mean 'locate_theme'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'locate_theme'?", "location": {"path": "minimal-computing/jekyll-customization/customize-minima-theme.md", "range": {"start": {"line": 49, "column": 3}}}, "severity": "ERROR"}

c. Invoke explorer with the provided path, substituting `/` with `\`
c. Invoke explorer with the provided path, substituting `/` with `\`.

For example:

Expand Down
4 changes: 2 additions & 2 deletions minimal-computing/jekyll-customization/data-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ nav_order: 8

In this section, you will be provided with steps to create a `locations.md` page that loads data from the `locations.csv` file, utilizing Jekyll's ability to load data from various file formats like CSV and YAML.

Check warning on line 10 in minimal-computing/jekyll-customization/data-page.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/jekyll-customization/data-page.md#L10

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "minimal-computing/jekyll-customization/data-page.md", "range": {"start": {"line": 10, "column": 22}}}, "severity": "WARNING"}

Check notice on line 10 in minimal-computing/jekyll-customization/data-page.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/jekyll-customization/data-page.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": "minimal-computing/jekyll-customization/data-page.md", "range": {"start": {"line": 10, "column": 27}}}, "severity": "INFO"}

Check notice on line 10 in minimal-computing/jekyll-customization/data-page.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/jekyll-customization/data-page.md#L10

[Google.Passive] In general, use active voice instead of passive voice ('be provided').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('be provided').", "location": {"path": "minimal-computing/jekyll-customization/data-page.md", "range": {"start": {"line": 10, "column": 27}}}, "severity": "INFO"}

Check warning on line 10 in minimal-computing/jekyll-customization/data-page.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/jekyll-customization/data-page.md#L10

[write-good.Passive] 'be provided' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'be provided' may be passive voice. Use active voice if you can.", "location": {"path": "minimal-computing/jekyll-customization/data-page.md", "range": {"start": {"line": 10, "column": 27}}}, "severity": "WARNING"}

Check warning on line 10 in minimal-computing/jekyll-customization/data-page.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/jekyll-customization/data-page.md#L10

[write-good.Weasel] 'various' is a weasel word!
Raw output
{"message": "[write-good.Weasel] 'various' is a weasel word!", "location": {"path": "minimal-computing/jekyll-customization/data-page.md", "range": {"start": {"line": 10, "column": 174}}}, "severity": "WARNING"}

1. **In the `_data` folder, create a data file named `locations.csv`**
1. **In the `_data` folder, create a data file named `locations.csv`.**

An example of the `locations.csv` file content is provided below:

Check warning on line 14 in minimal-computing/jekyll-customization/data-page.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/jekyll-customization/data-page.md#L14

[write-good.Passive] 'is provided' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'is provided' may be passive voice. Use active voice if you can.", "location": {"path": "minimal-computing/jekyll-customization/data-page.md", "range": {"start": {"line": 14, "column": 52}}}, "severity": "WARNING"}

Check notice on line 14 in minimal-computing/jekyll-customization/data-page.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/jekyll-customization/data-page.md#L14

[Google.Passive] In general, use active voice instead of passive voice ('is provided').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is provided').", "location": {"path": "minimal-computing/jekyll-customization/data-page.md", "range": {"start": {"line": 14, "column": 52}}}, "severity": "INFO"}

Check notice on line 14 in minimal-computing/jekyll-customization/data-page.md

View workflow job for this annotation

GitHub Actions / vale

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

Expand All @@ -29,7 +29,7 @@ In this section, you will be provided with steps to create a `locations.md` page
"Vaughan","Ontario","L4K 1Y5"
```
2. **In your Jekyll folder, create a page named `locations.md`**
2. **In your Jekyll folder, create a page named `locations.md`.**
An example of the `locations.csv` file content is provided below:

Check notice on line 34 in minimal-computing/jekyll-customization/data-page.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/jekyll-customization/data-page.md#L34

[Google.Passive] In general, use active voice instead of passive voice ('is provided').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is provided').", "location": {"path": "minimal-computing/jekyll-customization/data-page.md", "range": {"start": {"line": 34, "column": 52}}}, "severity": "INFO"}

Check notice on line 34 in minimal-computing/jekyll-customization/data-page.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/jekyll-customization/data-page.md#L34

[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/jekyll-customization/data-page.md", "range": {"start": {"line": 34, "column": 52}}}, "severity": "INFO"}

Check warning on line 34 in minimal-computing/jekyll-customization/data-page.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/jekyll-customization/data-page.md#L34

[write-good.Passive] 'is provided' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'is provided' may be passive voice. Use active voice if you can.", "location": {"path": "minimal-computing/jekyll-customization/data-page.md", "range": {"start": {"line": 34, "column": 52}}}, "severity": "WARNING"}
Expand Down
4 changes: 2 additions & 2 deletions minimal-computing/jekyll-customization/footer.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ parent: Minimal Computing
nav_order: 6
---

### Create a File Named `footer_pages.yml` in `_data` folder
## Create a File Named `footer_pages.yml` in `_data` folder

Check warning on line 8 in minimal-computing/jekyll-customization/footer.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/jekyll-customization/footer.md#L8

[Google.Headings] 'Create a File Named **************** in ***** folder' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Create a File Named **************** in ***** folder' should use sentence-style capitalization.", "location": {"path": "minimal-computing/jekyll-customization/footer.md", "range": {"start": {"line": 8, "column": 1}}}, "severity": "WARNING"}

An example of the `footer_pages.yml` file content is provided below:

Check notice on line 10 in minimal-computing/jekyll-customization/footer.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/jekyll-customization/footer.md#L10

[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/jekyll-customization/footer.md", "range": {"start": {"line": 10, "column": 51}}}, "severity": "INFO"}

Check notice on line 10 in minimal-computing/jekyll-customization/footer.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/jekyll-customization/footer.md#L10

[Google.Passive] In general, use active voice instead of passive voice ('is provided').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is provided').", "location": {"path": "minimal-computing/jekyll-customization/footer.md", "range": {"start": {"line": 10, "column": 51}}}, "severity": "INFO"}

Check warning on line 10 in minimal-computing/jekyll-customization/footer.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/jekyll-customization/footer.md#L10

[write-good.Passive] 'is provided' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'is provided' may be passive voice. Use active voice if you can.", "location": {"path": "minimal-computing/jekyll-customization/footer.md", "range": {"start": {"line": 10, "column": 51}}}, "severity": "WARNING"}

Expand All @@ -16,7 +16,7 @@ links:
- privacypolicy.md
```
### Create a File Named `footer.html` in `_includes` folder
## Create a File Named `footer.html` in `_includes` folder

Check warning on line 19 in minimal-computing/jekyll-customization/footer.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/jekyll-customization/footer.md#L19

[Google.Headings] 'Create a File Named *********** in ********* folder' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Create a File Named *********** in ********* folder' should use sentence-style capitalization.", "location": {"path": "minimal-computing/jekyll-customization/footer.md", "range": {"start": {"line": 19, "column": 1}}}, "severity": "WARNING"}

An example of the `footer.html` file content is provided below:

Check notice on line 21 in minimal-computing/jekyll-customization/footer.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/jekyll-customization/footer.md#L21

[Google.Passive] In general, use active voice instead of passive voice ('is provided').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is provided').", "location": {"path": "minimal-computing/jekyll-customization/footer.md", "range": {"start": {"line": 21, "column": 46}}}, "severity": "INFO"}

Check notice on line 21 in minimal-computing/jekyll-customization/footer.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/jekyll-customization/footer.md#L21

[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/jekyll-customization/footer.md", "range": {"start": {"line": 21, "column": 46}}}, "severity": "INFO"}

Check warning on line 21 in minimal-computing/jekyll-customization/footer.md

View workflow job for this annotation

GitHub Actions / vale

[vale] minimal-computing/jekyll-customization/footer.md#L21

[write-good.Passive] 'is provided' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'is provided' may be passive voice. Use active voice if you can.", "location": {"path": "minimal-computing/jekyll-customization/footer.md", "range": {"start": {"line": 21, "column": 46}}}, "severity": "WARNING"}

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 @@ -20,13 +20,13 @@ Jekyll requires the following:
### Instructions
1. Install all [prerequisites](https://jekyllrb.com/docs/installation/).
2. Open a command-line terminal.
3. Install Jekyll and the bundler gems
3. Install Jekyll and the bundler gems.

Check failure on line 23 in minimal-computing/minimal-site.md

View workflow job for this annotation

GitHub Actions / vale

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

[Vale.Spelling] Did you really mean 'bundler'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'bundler'?", "location": {"path": "minimal-computing/minimal-site.md", "range": {"start": {"line": 23, "column": 27}}}, "severity": "ERROR"}

```bash
gem install jekyll bundler
```
4. Go to the directory where you want to save the site. For example, C:\Users\user\Documents
5. Run the commands
4. Go to the directory where you want to save the site. For example, "C:\Users\user\Documents".

Check failure on line 28 in minimal-computing/minimal-site.md

View workflow job for this annotation

GitHub Actions / vale

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

[Google.Quotes] Commas and periods go inside quotation marks.
Raw output
{"message": "[Google.Quotes] Commas and periods go inside quotation marks.", "location": {"path": "minimal-computing/minimal-site.md", "range": {"start": {"line": 28, "column": 70}}}, "severity": "ERROR"}
5. Run the commands.

```bash
jekyll new minima-site
Expand Down

0 comments on commit 929f34a

Please sign in to comment.