diff --git a/index.md b/index.md index baae394..d8f2a33 100644 --- a/index.md +++ b/index.md @@ -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: -- 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. +- 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. diff --git a/minimal-computing/deployment.md b/minimal-computing/deployment.md index be8bd39..2ae2d61 100644 --- a/minimal-computing/deployment.md +++ b/minimal-computing/deployment.md @@ -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. -### A. Creating a repository on GitHub +## A. Creating a repository on GitHub 1. Login to GitHub. 2. From the menu go to “Your repositories.” 3. Click on “New” button to create a new repository. @@ -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 1. On the new repository main page click on “add file” button and select “Upload files” option. 2. Upload all the files that are in the “minima-site” folder. 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, @@ -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 1. Navigate to “Settings.” 2. Go to the “Pages” tab. diff --git a/minimal-computing/jekyll-customization/customize-minima-theme.md b/minimal-computing/jekyll-customization/customize-minima-theme.md index 6bf882b..e307216 100644 --- a/minimal-computing/jekyll-customization/customize-minima-theme.md +++ b/minimal-computing/jekyll-customization/customize-minima-theme.md @@ -48,7 +48,7 @@ For example: ![locate_theme](assets/img/locate_theme.png) -c. Invoke explorer with the provided path, substituting `/` with `\` +c. Invoke explorer with the provided path, substituting `/` with `\`. For example: diff --git a/minimal-computing/jekyll-customization/data-page.md b/minimal-computing/jekyll-customization/data-page.md index 96f41c3..a4bc954 100644 --- a/minimal-computing/jekyll-customization/data-page.md +++ b/minimal-computing/jekyll-customization/data-page.md @@ -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. -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: @@ -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: diff --git a/minimal-computing/jekyll-customization/footer.md b/minimal-computing/jekyll-customization/footer.md index c7b7a23..c247800 100644 --- a/minimal-computing/jekyll-customization/footer.md +++ b/minimal-computing/jekyll-customization/footer.md @@ -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 An example of the `footer_pages.yml` file content is provided below: @@ -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 An example of the `footer.html` file content is provided below: diff --git a/minimal-computing/minimal-site.md b/minimal-computing/minimal-site.md index 59a8952..b7ed6a5 100644 --- a/minimal-computing/minimal-site.md +++ b/minimal-computing/minimal-site.md @@ -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. ```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". +5. Run the commands. ```bash jekyll new minima-site