From 3226496e6ae2c78cc88647aa98180ccfc2db9332 Mon Sep 17 00:00:00 2001 From: Jyoti Bhogal Date: Wed, 23 Oct 2024 16:55:11 +0530 Subject: [PATCH 01/23] :books: add section on how to install new theme --- CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dd297008..e4384210 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -103,6 +103,38 @@ Provide more context by answering the following questions: # How to install a new theme? +This website is built on Hugo framework. To install a new Hugo theme, please take the following steps: + +## Assumptions + +1. You have already installed Hugo on your machine +2. You have git installed on your machine and you are familiar with basic git usage. + +## Installing a single theme + +1. In your IDE, go to `themes` directory. + +```zsh +cd themes +``` + +2. Download a theme by replacing `URL_to_theme` with the URL of the theme GitHub repository + +```zsh +git clone URL_to_theme +``` + +3. Alternatively, download the theme as a `.zip` file from the GitHub repository, unzip the theme contents, and then manually move the unzipped source into your `themes` directory. + +## Adding theme + +1. Add the theme to your site configuration file `config.toml` using the following code: + +```zsh +theme: themename +``` +Note: Here `themename` is the exact name of the theme as mentioned in the `/themes` directory. + # How to make a table? Here is a step-by-step demo about making a table: From 64ca6837fe31c83a788397248615a8b07708d0f7 Mon Sep 17 00:00:00 2001 From: Jyoti Bhogal Date: Wed, 23 Oct 2024 16:57:55 +0530 Subject: [PATCH 02/23] :books: edit code to install new theme --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e4384210..f969fe65 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -131,7 +131,7 @@ git clone URL_to_theme 1. Add the theme to your site configuration file `config.toml` using the following code: ```zsh -theme: themename +theme = "themename" ``` Note: Here `themename` is the exact name of the theme as mentioned in the `/themes` directory. From 31e60bd020db23d868bd96c01e915c2cbcbada0a Mon Sep 17 00:00:00 2001 From: Jyoti Bhogal Date: Wed, 23 Oct 2024 17:38:38 +0530 Subject: [PATCH 03/23] add details on creating table in markdown --- CONTRIBUTING.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f969fe65..b634d4e3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -139,6 +139,27 @@ Note: Here `themename` is the exact name of the theme as mentioned in the `/them Here is a step-by-step demo about making a table: +1. A verticle line `|` should be added to both the ends of each row. +2. Separate the columns by a verticle line `|` +3. The column header can be separated from the remaining row by using three or more dashes `---` + +For example, the below code will result in the table that follows it: + +```zsh +| Country| Capital City | +| --- | --- | +| Canada | Ottawa | +| Australia | Canberra | +| Egypt | Cairo | +``` + +| Country| Capital City | +| --- | --- | +| Canada | Ottawa | +| Australia | Canberra | +| Egypt | Cairo | + + # How to add an image? Here is a step-by-step demo about how to add an image: From a147e4ec6417af49def464e67908f047c5017187 Mon Sep 17 00:00:00 2001 From: Jyoti Bhogal Date: Wed, 23 Oct 2024 17:45:49 +0530 Subject: [PATCH 04/23] :books: steps to format table in markdown --- CONTRIBUTING.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b634d4e3..f5deb6b6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -139,6 +139,8 @@ Note: Here `themename` is the exact name of the theme as mentioned in the `/them Here is a step-by-step demo about making a table: +## Create a basic table + 1. A verticle line `|` should be added to both the ends of each row. 2. Separate the columns by a verticle line `|` 3. The column header can be separated from the remaining row by using three or more dashes `---` @@ -159,6 +161,30 @@ For example, the below code will result in the table that follows it: | Australia | Canberra | | Egypt | Cairo | +Here are the steps to **format** the table: + +## Text Alignment + +1. To align text in the columns to the left, right, or center add a colon `:` to the left, right, or on both side of the dashes`---` within the header row. +2. `:--`: left alignment +3. `--:`: right alignment +4. `:-:`: center alignment + +For example, the below code will result in the table that follows it: + +```zsh +| Country| Capital City | +| :---: | :---: | +| Canada | Ottawa | +| Australia | Canberra | +| Egypt | Cairo | +``` + +| Country| Capital City | +| :---: | :---: | +| Canada | Ottawa | +| Australia | Canberra | +| Egypt | Cairo | # How to add an image? From 6eedb442214e591467dfd1bc0d53496fe59d728b Mon Sep 17 00:00:00 2001 From: Jyoti Bhogal Date: Wed, 23 Oct 2024 17:48:54 +0530 Subject: [PATCH 05/23] :books:change table column width --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f5deb6b6..7f2c8463 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -158,7 +158,7 @@ For example, the below code will result in the table that follows it: | Country| Capital City | | --- | --- | | Canada | Ottawa | -| Australia | Canberra | +| Australia Canberra Cairo| Canberra | | Egypt | Cairo | Here are the steps to **format** the table: From 785d77a15201e46811cb33236a3846be606f6864 Mon Sep 17 00:00:00 2001 From: Jyoti Bhogal Date: Wed, 23 Oct 2024 18:51:44 +0530 Subject: [PATCH 06/23] table formatting --- CONTRIBUTING.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7f2c8463..bce3713d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -158,7 +158,7 @@ For example, the below code will result in the table that follows it: | Country| Capital City | | --- | --- | | Canada | Ottawa | -| Australia Canberra Cairo| Canberra | +| Australia | Canberra | | Egypt | Cairo | Here are the steps to **format** the table: @@ -186,6 +186,26 @@ For example, the below code will result in the table that follows it: | Australia | Canberra | | Egypt | Cairo | +## Going to next line + +To go to next line in a row, use `\`. + +```zsh +| Country| Capital City | +| --- | --- | +| Canada | Ottawa \ Ontario | +| Australia | Canberra | +| Egypt | Cairo | +``` + +| Country| Capital City | +| --- | --- | +| Canada | Ottawa \ Ontario | +| Australia | Canberra | +| Egypt | Cairo | + +Note: the text in the table can be further formatted. For example, links, inline code (words or phrases in backtics only, not code blocks) + # How to add an image? Here is a step-by-step demo about how to add an image: From 2a0cf59729b3b38981f70ddb29db5029b76d080e Mon Sep 17 00:00:00 2001 From: Jyoti Bhogal Date: Wed, 23 Oct 2024 18:59:28 +0530 Subject: [PATCH 07/23] add new line in markdown table --- CONTRIBUTING.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bce3713d..5ffa5e6d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -193,14 +193,16 @@ To go to next line in a row, use `\`. ```zsh | Country| Capital City | | --- | --- | -| Canada | Ottawa \ Ontario | +| Canada | Ottawa +Ontario| | Australia | Canberra | | Egypt | Cairo | ``` | Country| Capital City | | --- | --- | -| Canada | Ottawa \ Ontario | +| Canada | Ottawa +Ontario| | Australia | Canberra | | Egypt | Cairo | From 0f503f889a37d070300a63958d4ac8fb6747508b Mon Sep 17 00:00:00 2001 From: Jyoti Bhogal Date: Wed, 23 Oct 2024 19:40:02 +0530 Subject: [PATCH 08/23] new line in table --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5ffa5e6d..c52e9091 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -194,7 +194,7 @@ To go to next line in a row, use `\`. | Country| Capital City | | --- | --- | | Canada | Ottawa -Ontario| +| --- | Ontario| | Australia | Canberra | | Egypt | Cairo | ``` From 0591d206541e4775117dc3daef41378f915ab3c2 Mon Sep 17 00:00:00 2001 From: Jyoti Bhogal Date: Wed, 23 Oct 2024 19:42:42 +0530 Subject: [PATCH 09/23] new line in makrdown table --- CONTRIBUTING.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c52e9091..4c4a538d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -193,8 +193,7 @@ To go to next line in a row, use `\`. ```zsh | Country| Capital City | | --- | --- | -| Canada | Ottawa -| --- | Ontario| +| Canada | Ottawa \n Ontario | | Australia | Canberra | | Egypt | Cairo | ``` From b007d844c51f68bcd4c36fa0d783aef6943dd229 Mon Sep 17 00:00:00 2001 From: Jyoti Bhogal Date: Thu, 24 Oct 2024 18:27:27 +0530 Subject: [PATCH 10/23] add markdown lint checks and modify contributing guidelines --- .github/workflows/markdownlint-cli2.yml | 27 ++++++ CONTRIBUTING.md | 104 +++++++++++------------- readme.md | 2 +- 3 files changed, 75 insertions(+), 58 deletions(-) create mode 100644 .github/workflows/markdownlint-cli2.yml diff --git a/.github/workflows/markdownlint-cli2.yml b/.github/workflows/markdownlint-cli2.yml new file mode 100644 index 00000000..1283c0bd --- /dev/null +++ b/.github/workflows/markdownlint-cli2.yml @@ -0,0 +1,27 @@ +name: Markdown Lint + +on: + # This triggers the workflow when pushing or pulling changes to any branch + push: + branches: + - '**' + pull_request: + branches: + - '**' + +jobs: + lint-markdown: + runs-on: ubuntu-latest + + steps: + # Checkout the repository + - name: Checkout code + uses: actions/checkout@v3 + + # Run markdownlint on the specified files + - name: Lint markdown files + uses: DavidAnson/markdownlint-cli2-action@v17 + with: + globs: | + readme.md + CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4c4a538d..7efe09ea 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,7 +16,6 @@ Before creating bug reports, please check [this list](#before-submitting-a-bug-r > **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one. - #### Before Submitting A Bug Report * **Perform a [cursory search](https://github.com/researchsoft/website/issues?q=is%3Aopen+is%3Aissue)** to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one. @@ -28,7 +27,7 @@ Bugs are tracked as GitHub issues. To report a bug, create an issue in the [webs Explain the problem and include additional details to help maintainers reproduce the probelem: * **Use clear and descriptive title** for the issue to identify the problem. -* **Describe the exact steps to reproduce the problem** n as many details as possible. For example: which command do you use in the terminal or in GitHub browser. Explain **how you did different steps, in addition to what you did**. For example: if you moved your cursor to next line, please mention if you used the mouse, or a keyboard button or a programming command in an IDE or GitHub browser. +* **Describe the exact steps to reproduce the problem** n as many details as possible. For example: which command do you use in the terminal or in GitHub browser. Explain **how you did different steps, in addition to what you did**. For example: if you moved your cursor to next line, please mention if you used the mouse, or a keyboard button or a programming command in an IDE or GitHub browser. * **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable text or code. * **Describe the behavior you observed after followig the steps** and point out the exact problem in that behaviour/output. * **Explain what behaviour you expected to see instead and why**. @@ -39,11 +38,10 @@ Provide more context by answering the following questions: * Can you reproduce the problem on another branch? * Did the problem started happening recently i.e. in the new website (i.e. when theme is beautifulhugo) or was this a problem in the older version too (i.e. when theme is Syna)? * **Can you reliably reproduce the issue?** If not, please describe how often the problem occurs and under what conditions does it normally occur. -* If the problem is related to working with files (e.g. opening or editing files), **does the problem occur for all the files and folders?** Does the problem occur only when working with local or remote files (e.g., on network drives), with specific type of file (e.g. .md or .html, etc.), with files with large size, with files with more number of lines, with files with a specific encoding? It there anything else specific about the files you are using? +* If the problem is related to working with files (e.g. opening or editing files), **does the problem occur for all the files and folders?** Does the problem occur only when working with local or remote files (e.g., on network drives), with specific type of file (e.g. .md or .html, etc.), with files with large size, with files with more number of lines, with files with a specific encoding? It there anything else specific about the files you are using? ### Suggesting Enhancements - #### Before Submitting An Enhancement Suggestion #### How Do I Submit A (Good) Enhancement Suggestion? @@ -58,27 +56,27 @@ Provide more context by answering the following questions: * Reference issues and pull requests liberally after the first line * When only changing documentation, include `[ci skip]` in the commit title * Consider starting the commit message with an applicable emoji: - * :art: `:art:` when improving the format/structure of the code - * :racehorse: `:racehorse:` when improving performance - * :non-potable_water: `:non-potable_water:` when plugging memory leaks - * :memo: `:memo:` when writing docs - * :penguin: `:penguin:` when fixing something on Linux - * :apple: `:apple:` when fixing something on macOS - * :checkered_flag: `:checkered_flag:` when fixing something on Windows - * :bug: `:bug:` when fixing a bug - * :fire: `:fire:` when removing code or files - * :green_heart: `:green_heart:` when fixing the CI build - * :white_check_mark: `:white_check_mark:` when adding tests - * :lock: `:lock:` when dealing with security - * :arrow_up: `:arrow_up:` when upgrading dependencies - * :arrow_down: `:arrow_down:` when downgrading dependencies - * :shirt: `:shirt:` when removing linter warnings + * :art: `:art:` when improving the format/structure of the code + * :racehorse: `:racehorse:` when improving performance + * :non-potable_water: `:non-potable_water:` when plugging memory leaks + * :memo: `:memo:` when writing docs + * :penguin: `:penguin:` when fixing something on Linux + * :apple: `:apple:` when fixing something on macOS + * :checkered_flag: `:checkered_flag:` when fixing something on Windows + * :bug: `:bug:` when fixing a bug + * :fire: `:fire:` when removing code or files + * :green_heart: `:green_heart:` when fixing the CI build + * :white_check_mark: `:white_check_mark:` when adding tests + * :lock: `:lock:` when dealing with security + * :arrow_up: `:arrow_up:` when upgrading dependencies + * :arrow_down: `:arrow_down:` when downgrading dependencies + * :shirt: `:shirt:` when removing linter warnings ### Additional Notes #### Issue Labels -| Label Name | Description +| Label Name | Description | | --- | --- | | `enhancement` | New feature or request | | `bug` | Something is not working as expected | @@ -92,58 +90,51 @@ Provide more context by answering the following questions: | `inavlid` | This doesn't seem right (e.g. user error) | | `wrong-repo` | Issues reported on the wrong repository | -#### Pull Request Labels +#### Pull Request Labels -| Label Name | Description +| Label Name | Description | | --- | --- | | `work-in-progress` | Pull requests which are still being worked on, more changes will follow | | `testing` | To test new or exisitng features, functions, or code | | `needs-review`| To indicate that a pull request requires review | | `under-review` | To indicate that a pull request is under review | -# How to install a new theme? +## Installing a new theme This website is built on Hugo framework. To install a new Hugo theme, please take the following steps: -## Assumptions +### Assumptions 1. You have already installed Hugo on your machine 2. You have git installed on your machine and you are familiar with basic git usage. -## Installing a single theme +### Adding a new theme -1. In your IDE, go to `themes` directory. +* You can add a new theme as a submodule as follows: ```zsh -cd themes +git submodule init # If you haven't initialized before +git submodule add https://github.com/halogenica/beautifulhugo.git themes/beautifulhugo # This would add the beautifulhugo theme ``` -2. Download a theme by replacing `URL_to_theme` with the URL of the theme GitHub repository - -```zsh -git clone URL_to_theme -``` - -3. Alternatively, download the theme as a `.zip` file from the GitHub repository, unzip the theme contents, and then manually move the unzipped source into your `themes` directory. - -## Adding theme - -1. Add the theme to your site configuration file `config.toml` using the following code: +* The theme is successfully installed if you see it inside the `/themes` directory (for example, in this case you will see `/themes/beautifulhugo/`). +* To use the theme, make sure that you set it accordingly in the `config.toml`: ```zsh theme = "themename" ``` -Note: Here `themename` is the exact name of the theme as mentioned in the `/themes` directory. -# How to make a table? +**Note**: Here `"themename"` is the exact name of the theme as mentioned in the `/themes` directory (for example, in this case it will be `theme = "beautifulhugo"`). + +## Adding a table Here is a step-by-step demo about making a table: -## Create a basic table +### Create a basic table -1. A verticle line `|` should be added to both the ends of each row. -2. Separate the columns by a verticle line `|` -3. The column header can be separated from the remaining row by using three or more dashes `---` +* A verticle line `|` should be added to both the ends of each row. +* Separate the columns by a verticle line `|` +* The column header can be separated from the remaining row by using three or more dashes `---` For example, the below code will result in the table that follows it: @@ -163,12 +154,12 @@ For example, the below code will result in the table that follows it: Here are the steps to **format** the table: -## Text Alignment +### Text Alignment -1. To align text in the columns to the left, right, or center add a colon `:` to the left, right, or on both side of the dashes`---` within the header row. -2. `:--`: left alignment -3. `--:`: right alignment -4. `:-:`: center alignment +* To align text in the columns to the left, right, or center add a colon `:` to the left, right, or on both side of the dashes`---` within the header row. +* `:--`: left alignment +* `--:`: right alignment +* `:-:`: center alignment For example, the below code will result in the table that follows it: @@ -186,28 +177,27 @@ For example, the below code will result in the table that follows it: | Australia | Canberra | | Egypt | Cairo | -## Going to next line +### Going to next line To go to next line in a row, use `\`. ```zsh -| Country| Capital City | +| Country | Capital City | | --- | --- | -| Canada | Ottawa \n Ontario | +| Canada | Ottawa | | Australia | Canberra | | Egypt | Cairo | ``` -| Country| Capital City | +| Country | Capital City | | --- | --- | -| Canada | Ottawa -Ontario| +| Canada | Ottawa | | Australia | Canberra | | Egypt | Cairo | -Note: the text in the table can be further formatted. For example, links, inline code (words or phrases in backtics only, not code blocks) +**Note**: the text in the table can be further formatted. For example, links, inline code (words or phrases in backtics only, not code blocks) -# How to add an image? +## Adding an image Here is a step-by-step demo about how to add an image: diff --git a/readme.md b/readme.md index f1c01b3a..c056fc1c 100644 --- a/readme.md +++ b/readme.md @@ -51,7 +51,7 @@ git push --set-upstream origin new_branch_name # if pushing for the first time t git push # if pushing to an existing branch ``` -- Create a Pull Request (PR) on GitHub repo and direct it to the `dev` branch from your branch. Tag any relevant issue(s), add relevant label(s), and request reviews where required. +- Create a Pull Request (PR) on GitHub repo and direct it to the `dev` branch from your branch. Tag any relevant issue(s), add relevant label(s), and request reviews where required. ### Using GitHub text editor interface From 4450abc3207d402b07a8308ab5edc26c43b106ee Mon Sep 17 00:00:00 2001 From: Jyoti Bhogal Date: Thu, 24 Oct 2024 19:11:42 +0530 Subject: [PATCH 11/23] make lint happy --- CONTRIBUTING.md | 99 ++++++++++++++++++++++++++++++++++++------------- readme.md | 43 ++++++++++++++++----- 2 files changed, 107 insertions(+), 35 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7efe09ea..7ddd0fc4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,43 +2,81 @@ :+1::tada: First off, thanks for taking the time to contribute! :tada::+1: -The following is a set of guidelines for contributing to the ReSA website, which is hosted in the [ReSA Organization](https://github.com/researchsoft) on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. +The following is a set of guidelines for contributing to the ReSA website, +which is hosted in the [ReSA Organization](https://github.com/researchsoft) +on GitHub. These are mostly guidelines, not rules. Use your best judgment, +and feel free to propose changes to this document in a pull request. -This guide is inspired from [Atom's contributing guidelines](https://github.com/atom/atom/blob/master/CONTRIBUTING.md). +This guide is inspired from +[Atom's contributing guidelines]( +CONTRIBUTING.md). ## How Can I Contribute? ### Reporting Bugs -This section guides you through submitting a bug report for Research Software Alliance. Following these guidelines helps maintainers understand your report :pencil:, reproduce the behavior :computer: :computer:, and find related reports :mag_right:. +This section guides you through submitting a bug report for Research +Software Alliance. Following these guidelines helps maintainers understand your +report :pencil:, reproduce the behavior :computer: :computer:, and find +related reports :mag_right:. -Before creating bug reports, please check [this list](#before-submitting-a-bug-report) as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). +Before creating bug reports, please check +[this list](#before-submitting-a-bug-report) as you might find out that you +don't need to create one. When you are creating a bug report, please +[include as many details as possible](#how-do-i-submit-a-good-bug-report). -> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one. +> **Note:** If you find a **Closed** issue that seems like it is the same thing +that you're experiencing, open a new issue and include a link to the original +issue in the body of your new one. #### Before Submitting A Bug Report -* **Perform a [cursory search](https://github.com/researchsoft/website/issues?q=is%3Aopen+is%3Aissue)** to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one. +* **Perform a +[cursory search]( +issues?q=is%3Aopen+is%3Aissue)** to see if the problem has already been +reported. If it has **and the issue is still open**, add a comment to the +existing issue instead of opening a new one. #### How Do I Submit A (Good) Bug Report? -Bugs are tracked as GitHub issues. To report a bug, create an issue in the [website repository](https://github.com/researchsoft/website) by filling in the [bug report template](https://github.com/researchsoft/website//issues/new?assignees=&labels=bug%2Cneeds+triage&projects=&template=bug_report.yaml&title=BUG%3A+). +Bugs are tracked as GitHub issues. To report a bug, create an issue in the +[website repository](https://github.com/researchsoft/website) by filling in the +[bug report template]( +new?assignees=&labels=bug%2Cneeds+triage&projects=& +template=bug_report.yaml&title=BUG%3A+). -Explain the problem and include additional details to help maintainers reproduce the probelem: +Explain the problem and include additional details to help maintainers +reproduce the probelem: * **Use clear and descriptive title** for the issue to identify the problem. -* **Describe the exact steps to reproduce the problem** n as many details as possible. For example: which command do you use in the terminal or in GitHub browser. Explain **how you did different steps, in addition to what you did**. For example: if you moved your cursor to next line, please mention if you used the mouse, or a keyboard button or a programming command in an IDE or GitHub browser. -* **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable text or code. -* **Describe the behavior you observed after followig the steps** and point out the exact problem in that behaviour/output. +* **Describe the exact steps to reproduce the problem** n as many details as +possible. For example: which command do you use in the terminal or in GitHub +browser. Explain **how you did different steps, in addition to what you did**. +For example: if you moved your cursor to next line, please mention if you used +the mouse, or a keyboard button or a programming command in an IDE or GitHub +browser. +* **Provide specific examples to demonstrate the steps**. Include links to +files or GitHub projects, or copy/pasteable text or code. +* **Describe the behavior you observed after followig the steps** and point out +the exact problem in that behaviour/output. * **Explain what behaviour you expected to see instead and why**. -* **Include screenshots or animated GIF/video** which show how you followed the steps and clearly demonstrate the problem in the output you observe. +* **Include screenshots or animated GIF/video** which show how you followed the +steps and clearly demonstrate the problem in the output you observe. Provide more context by answering the following questions: * Can you reproduce the problem on another branch? -* Did the problem started happening recently i.e. in the new website (i.e. when theme is beautifulhugo) or was this a problem in the older version too (i.e. when theme is Syna)? -* **Can you reliably reproduce the issue?** If not, please describe how often the problem occurs and under what conditions does it normally occur. -* If the problem is related to working with files (e.g. opening or editing files), **does the problem occur for all the files and folders?** Does the problem occur only when working with local or remote files (e.g., on network drives), with specific type of file (e.g. .md or .html, etc.), with files with large size, with files with more number of lines, with files with a specific encoding? It there anything else specific about the files you are using? +* Did the problem started happening recently i.e. in the new website (i.e. when +theme is beautifulhugo) or was this a problem in the older version too (i.e. +when theme is Syna)? +* **Can you reliably reproduce the issue?** If not, please describe how often +the problem occurs and under what conditions does it normally occur. +* If the problem is related to working with files (e.g. opening or editing +files), **does the problem occur for all the files and folders?** Does the +problem occur only when working with local or remote files (e.g., on network +drives), with specific type of file (e.g. .md or .html, etc.), with files with +large size, with files with more number of lines, with files with a specific +encoding? It there anything else specific about the files you are using? ### Suggesting Enhancements @@ -83,7 +121,7 @@ Provide more context by answering the following questions: | `question` | Further information is requested | | `feedback` | General feedback more than bug reports or feature requests | | `help wanted` | Extra attention is needed | -| `good first issue` | Less complex issues that would be good for new contributors | +| `good first issue` | Easy issues that would be good for new contributors | | `blocked` | Issues blocked/dependent on other issues | | `duplicate` | This issue or pull request already exists | | `wontfix` | This will not be worked on| @@ -94,19 +132,21 @@ Provide more context by answering the following questions: | Label Name | Description | | --- | --- | -| `work-in-progress` | Pull requests which are still being worked on, more changes will follow | +| `work-in-progress` | PRs which are still being worked on | | `testing` | To test new or exisitng features, functions, or code | | `needs-review`| To indicate that a pull request requires review | | `under-review` | To indicate that a pull request is under review | ## Installing a new theme -This website is built on Hugo framework. To install a new Hugo theme, please take the following steps: +This website is built on Hugo framework. To install a new Hugo theme, please +take the following steps: ### Assumptions 1. You have already installed Hugo on your machine -2. You have git installed on your machine and you are familiar with basic git usage. +2. You have git installed on your machine and you are familiar with basic git +usage. ### Adding a new theme @@ -114,17 +154,21 @@ This website is built on Hugo framework. To install a new Hugo theme, please tak ```zsh git submodule init # If you haven't initialized before -git submodule add https://github.com/halogenica/beautifulhugo.git themes/beautifulhugo # This would add the beautifulhugo theme +git submodule add https://github.com/halogenica/beautifulhugo.git +themes/beautifulhugo # This would add the beautifulhugo theme ``` -* The theme is successfully installed if you see it inside the `/themes` directory (for example, in this case you will see `/themes/beautifulhugo/`). +* The theme is successfully installed if you see it inside the `/themes` +directory (for example, in this case you will see `/themes/beautifulhugo/`). * To use the theme, make sure that you set it accordingly in the `config.toml`: ```zsh theme = "themename" ``` -**Note**: Here `"themename"` is the exact name of the theme as mentioned in the `/themes` directory (for example, in this case it will be `theme = "beautifulhugo"`). +**Note**: Here `"themename"` is the exact name of the theme as mentioned in +the `/themes` directory (for example, in this case it will be +`theme = "beautifulhugo"`). ## Adding a table @@ -133,8 +177,9 @@ Here is a step-by-step demo about making a table: ### Create a basic table * A verticle line `|` should be added to both the ends of each row. -* Separate the columns by a verticle line `|` -* The column header can be separated from the remaining row by using three or more dashes `---` +* Separate the columns by a verticle line `|`. +* The column header can be separated from the remaining row by using three or +more dashes `---`. For example, the below code will result in the table that follows it: @@ -156,7 +201,8 @@ Here are the steps to **format** the table: ### Text Alignment -* To align text in the columns to the left, right, or center add a colon `:` to the left, right, or on both side of the dashes`---` within the header row. +* To align text in the columns to the left, right, or center add a colon `:` to +the left, right, or on both side of the dashes`---` within the header row. * `:--`: left alignment * `--:`: right alignment * `:-:`: center alignment @@ -195,7 +241,8 @@ To go to next line in a row, use `\`. | Australia | Canberra | | Egypt | Cairo | -**Note**: the text in the table can be further formatted. For example, links, inline code (words or phrases in backtics only, not code blocks) +**Note**: the text in the table can be further formatted. For example, links, +inline code (words or phrases in backtics only, not code blocks) ## Adding an image diff --git a/readme.md b/readme.md index c056fc1c..4eb769de 100644 --- a/readme.md +++ b/readme.md @@ -2,11 +2,19 @@ ## Overview -[![Netlify Status](https://api.netlify.com/api/v1/badges/b366fc0d-c20f-4312-a573-b3de6fa243fc/deploy-status)](https://app.netlify.com/sites/researchsoft/deploys) +[![Netlify Status](https://api.netlify.com/api/v1/ +badges/b366fc0d-c20f-4312-a573-b3de6fa243fc/deploy-status)](. +netlify.com/sites/researchsoft/deploys) -This repository contains the source files that generates the Research Software Alliance website. The repository is monitored by [Netlify](https://www.netlify.com/), which generates and hosts the live website. +This repository contains the source files that generates the Research Software +Alliance website. The repository is monitored by +[Netlify](https://www.netlify.com/), which generates and hosts the live +website. -The website uses the [Hugo framework](https://gohugo.io/) with the [Syna theme](https://about.okkur.org/syna/docs/). All content files are written in Markdown and are processed into HTML by [Netlify](https://app.netlify.com/sites/researchsoft/deploys). +The website uses the [Hugo framework](https://gohugo.io/) with the +[Syna theme](https://about.okkur.org/syna/docs/). All content files are written +in Markdown and are processed into HTML by [Netlify]( +sites/researchsoft/deploys). ## Editing content @@ -35,7 +43,8 @@ git checkout existing_branch_name # if you want to switch to an existing branch ```zsh git add --all # if you want to stage all the modified files -git add path_to_file # if you want to stage any specific modified file. To find the path to files that are modified use `git status` +git add path_to_file # if you want to stage any specific modified file. +# To find the path to files that are modified use `git status` ``` - Commit the staged changes using: @@ -47,18 +56,34 @@ git commit -m ":tada: an informative commit message" - Finally push your committed changes: ```zsh -git push --set-upstream origin new_branch_name # if pushing for the first time to a new branch +git push --set-upstream origin new_branch_name # if pushing for the first time +# to a new branch git push # if pushing to an existing branch ``` -- Create a Pull Request (PR) on GitHub repo and direct it to the `dev` branch from your branch. Tag any relevant issue(s), add relevant label(s), and request reviews where required. +- Create a Pull Request (PR) on GitHub repo and direct it to the `dev` branch +from your branch. Tag any relevant issue(s), add relevant label(s), and +request reviews where required. ### Using GitHub text editor interface -The only files that should be edited as a matter of course are in [content](https://github.com/researchsoft/website/tree/master/content). Images generally go into [static/images](https://github.com/researchsoft/website/tree/master/static/images). +The only files that should be edited as a matter of course are in +[content](https://github.com/researchsoft/website/tree/master/content). +Images generally go into [static/images] +(). -When editing existing content, it is possible to use the GitHub text editor interface to make changes. When viewing the file you would like to edit, click the Edit button to make your changes. If you do not have permissions for the repository directly, you will need to submit a pull request for an administrator to adopt the changes. +When editing existing content, it is possible to use the GitHub text editor +interface to make changes. When viewing the file you would like to edit, click +the Edit button to make your changes. If you do not have permissions for +the repository directly, you will need to submit a pull request for an +administrator to adopt the changes. ## Extra information -Due to limitations in the version of Hugo that Netlify runs, changing the _style_ of the website will require pulling this entire repo to a computer and building the site with hugo-extended. The resulting files generated in [resources/_gen/assets/scss/styles](https://github.com/researchsoft/website/tree/master/resources/_gen/assets/scss/styles]) then need to be committed back to the repository. +Due to limitations in the version of Hugo that Netlify runs, +changing the _style_ of the website will require pulling this entire +repo to a computer and building the site with hugo-extended. The resulting +files generated in +[resources/_gen/assets/scss/styles] +(< +scss/styles>) then need to be committed back to the repository. From fb9c3a185e0a61f889386e814d3364a4af197bba Mon Sep 17 00:00:00 2001 From: Jyoti Bhogal Date: Thu, 24 Oct 2024 19:32:16 +0530 Subject: [PATCH 12/23] keep spellcheck happy --- .github/workflows/spellcheck.yml | 28 ++++++++++++++++++++++++++++ CONTRIBUTING.md | 28 ++++++++++++++-------------- 2 files changed, 42 insertions(+), 14 deletions(-) create mode 100644 .github/workflows/spellcheck.yml diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml new file mode 100644 index 00000000..99519fdc --- /dev/null +++ b/.github/workflows/spellcheck.yml @@ -0,0 +1,28 @@ +name: Spellcheck Action + +on: + push: + branches: + - '**' + pull_request: + branches: + - '**' + +jobs: + spellcheck: + name: Spellcheck + runs-on: ubuntu-latest + + steps: + # Step 1: Checkout the repository + - name: Checkout code + uses: actions/checkout@v3 + + # Step 2: Run Spellcheck + - name: Spellcheck + uses: rojopolis/spellcheck-github-actions@0.43.1 + with: + source_files: | + readme.md + CONTRIBUTING.md + task_name: Markdown diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7ddd0fc4..af0dfe7a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,7 +46,7 @@ new?assignees=&labels=bug%2Cneeds+triage&projects=& template=bug_report.yaml&title=BUG%3A+). Explain the problem and include additional details to help maintainers -reproduce the probelem: +reproduce the problem: * **Use clear and descriptive title** for the issue to identify the problem. * **Describe the exact steps to reproduce the problem** n as many details as @@ -56,9 +56,9 @@ For example: if you moved your cursor to next line, please mention if you used the mouse, or a keyboard button or a programming command in an IDE or GitHub browser. * **Provide specific examples to demonstrate the steps**. Include links to -files or GitHub projects, or copy/pasteable text or code. -* **Describe the behavior you observed after followig the steps** and point out -the exact problem in that behaviour/output. +files or GitHub projects, or copy/paste text or code. +* **Describe the behavior you observed after following the steps** and +point out the exact problem in that behaviour/output. * **Explain what behaviour you expected to see instead and why**. * **Include screenshots or animated GIF/video** which show how you followed the steps and clearly demonstrate the problem in the output you observe. @@ -67,8 +67,8 @@ Provide more context by answering the following questions: * Can you reproduce the problem on another branch? * Did the problem started happening recently i.e. in the new website (i.e. when -theme is beautifulhugo) or was this a problem in the older version too (i.e. -when theme is Syna)? +theme is `beautifulhugo`) or was this a problem in the older version too (i.e. +when theme is `Syna`)? * **Can you reliably reproduce the issue?** If not, please describe how often the problem occurs and under what conditions does it normally occur. * If the problem is related to working with files (e.g. opening or editing @@ -86,7 +86,7 @@ encoding? It there anything else specific about the files you are using? ### Pull Requests -### Styleguide (Git Commit Messages) +### Style guide (Git Commit Messages) * Use the present tense ("Add feature" not "Added feature") * Use the imperative mood ("Move cursor to..." not "Moves cursor to...") @@ -125,7 +125,7 @@ encoding? It there anything else specific about the files you are using? | `blocked` | Issues blocked/dependent on other issues | | `duplicate` | This issue or pull request already exists | | `wontfix` | This will not be worked on| -| `inavlid` | This doesn't seem right (e.g. user error) | +| `invalid` | This doesn't seem right (e.g. user error) | | `wrong-repo` | Issues reported on the wrong repository | #### Pull Request Labels @@ -133,7 +133,7 @@ encoding? It there anything else specific about the files you are using? | Label Name | Description | | --- | --- | | `work-in-progress` | PRs which are still being worked on | -| `testing` | To test new or exisitng features, functions, or code | +| `testing` | To test new or existing features, functions, or code | | `needs-review`| To indicate that a pull request requires review | | `under-review` | To indicate that a pull request is under review | @@ -163,10 +163,10 @@ directory (for example, in this case you will see `/themes/beautifulhugo/`). * To use the theme, make sure that you set it accordingly in the `config.toml`: ```zsh -theme = "themename" +theme = "theme_name" ``` -**Note**: Here `"themename"` is the exact name of the theme as mentioned in +**Note**: Here `"theme_name"` is the exact name of the theme as mentioned in the `/themes` directory (for example, in this case it will be `theme = "beautifulhugo"`). @@ -176,8 +176,8 @@ Here is a step-by-step demo about making a table: ### Create a basic table -* A verticle line `|` should be added to both the ends of each row. -* Separate the columns by a verticle line `|`. +* A vertical line `|` should be added to both the ends of each row. +* Separate the columns by a vertical line `|`. * The column header can be separated from the remaining row by using three or more dashes `---`. @@ -242,7 +242,7 @@ To go to next line in a row, use `\`. | Egypt | Cairo | **Note**: the text in the table can be further formatted. For example, links, -inline code (words or phrases in backtics only, not code blocks) +inline code (words or phrases in backticks only, not code blocks) ## Adding an image From 62107ace7d6d1e951d877bb41c626c8f34c4a143 Mon Sep 17 00:00:00 2001 From: Jyoti Bhogal Date: Thu, 24 Oct 2024 19:46:00 +0530 Subject: [PATCH 13/23] spellcheck task removed --- .github/workflows/spellcheck.yml | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml index 99519fdc..ef74e8b9 100644 --- a/.github/workflows/spellcheck.yml +++ b/.github/workflows/spellcheck.yml @@ -18,11 +18,8 @@ jobs: - name: Checkout code uses: actions/checkout@v3 - # Step 2: Run Spellcheck + # Step 2: Run Spellcheck with default configuration - name: Spellcheck uses: rojopolis/spellcheck-github-actions@0.43.1 with: - source_files: | - readme.md - CONTRIBUTING.md - task_name: Markdown + source_files: readme.md CONTRIBUTING.md From c576fd098ddf4da1c85ddaf6d4b4759eb0685dd6 Mon Sep 17 00:00:00 2001 From: Jyoti Bhogal Date: Thu, 24 Oct 2024 19:51:53 +0530 Subject: [PATCH 14/23] spellcheck task add --- .github/workflows/spellcheck.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml index ef74e8b9..5949dcef 100644 --- a/.github/workflows/spellcheck.yml +++ b/.github/workflows/spellcheck.yml @@ -23,3 +23,4 @@ jobs: uses: rojopolis/spellcheck-github-actions@0.43.1 with: source_files: readme.md CONTRIBUTING.md + task_name: Markdown From f34b183ea1b8358cb103fa1987b06cf4d3c7916a Mon Sep 17 00:00:00 2001 From: Jyoti Bhogal Date: Thu, 24 Oct 2024 19:58:32 +0530 Subject: [PATCH 15/23] remove spellcheck GH action --- .github/workflows/spellcheck.yml | 26 -------------------------- 1 file changed, 26 deletions(-) delete mode 100644 .github/workflows/spellcheck.yml diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml deleted file mode 100644 index 5949dcef..00000000 --- a/.github/workflows/spellcheck.yml +++ /dev/null @@ -1,26 +0,0 @@ -name: Spellcheck Action - -on: - push: - branches: - - '**' - pull_request: - branches: - - '**' - -jobs: - spellcheck: - name: Spellcheck - runs-on: ubuntu-latest - - steps: - # Step 1: Checkout the repository - - name: Checkout code - uses: actions/checkout@v3 - - # Step 2: Run Spellcheck with default configuration - - name: Spellcheck - uses: rojopolis/spellcheck-github-actions@0.43.1 - with: - source_files: readme.md CONTRIBUTING.md - task_name: Markdown From 14d3e921b270877e6846f7a1b334a0adf75916c8 Mon Sep 17 00:00:00 2001 From: Jyoti Bhogal Date: Tue, 5 Nov 2024 19:18:53 +0530 Subject: [PATCH 16/23] change in sample table --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index af0dfe7a..f26eddf2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -241,8 +241,8 @@ To go to next line in a row, use `\`. | Australia | Canberra | | Egypt | Cairo | -**Note**: the text in the table can be further formatted. For example, links, -inline code (words or phrases in backticks only, not code blocks) +**Note**: the text in the table can be further formatted. For example, adding +links, inline code (words or phrases in backticks only, not code blocks). ## Adding an image From e80ea588ec5a85fae5aa0fa24f2f86c40d8680eb Mon Sep 17 00:00:00 2001 From: Jyoti Bhogal Date: Wed, 6 Nov 2024 18:23:44 +0530 Subject: [PATCH 17/23] configure image --- CONTRIBUTING.md | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f26eddf2..6ef73649 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -246,11 +246,32 @@ links, inline code (words or phrases in backticks only, not code blocks). ## Adding an image -Here is a step-by-step demo about how to add an image: +Here is a step-by-step demo about how to add an image using an IDE: -Step 1: +* Clone the `website` repository from . +* Upload the image to the folder website/static/images. +* Add image details to appropriate .md file using the following code: -Step 2: +```zsh ++++ +title = "" +#weight = + +[asset] + image = "image_name_with_file_extension" + url = "https://www.volkswagenstiftung.de/en" + text = "Volkswagen Foundation logo" ++++ +``` + +**Note**: + +* Here `"image_name_with_file_extension"` is the exact name of the image as +mentioned in the `/static` directory. +* `text` is used to give a short description of the image. +* `url` is an optional attribute. It is used if we want to hyperlink the image +with some relevant link. +* Image caption: ... Step x: How to add caption? From 7a9e3ca4a252cce14da9030712ad4f40eceff7ef Mon Sep 17 00:00:00 2001 From: Jyoti Bhogal Date: Wed, 6 Nov 2024 18:29:01 +0530 Subject: [PATCH 18/23] edit steps to add image --- CONTRIBUTING.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6ef73649..dbc6fb3d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -259,8 +259,8 @@ title = "" [asset] image = "image_name_with_file_extension" - url = "https://www.volkswagenstiftung.de/en" - text = "Volkswagen Foundation logo" + url = "relevant_url" + text = "image_short_description" +++ ``` @@ -268,9 +268,10 @@ title = "" * Here `"image_name_with_file_extension"` is the exact name of the image as mentioned in the `/static` directory. -* `text` is used to give a short description of the image. +* `text` is used to give a short description of the image. Please enter a +short description of the image after the `=` sign. * `url` is an optional attribute. It is used if we want to hyperlink the image -with some relevant link. +with some relevant link. Please enter the hyperlink after the `=` sign. * Image caption: ... From 32ec351fafeb59484af508c62fa4d7af34871935 Mon Sep 17 00:00:00 2001 From: Jyoti Bhogal Date: Wed, 20 Nov 2024 12:51:07 +0530 Subject: [PATCH 19/23] resolve broken links --- readme.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/readme.md b/readme.md index 4eb769de..c5fd4d7f 100644 --- a/readme.md +++ b/readme.md @@ -2,9 +2,7 @@ ## Overview -[![Netlify Status](https://api.netlify.com/api/v1/ -badges/b366fc0d-c20f-4312-a573-b3de6fa243fc/deploy-status)](. -netlify.com/sites/researchsoft/deploys) +[![Netlify Status](https://api.netlify.com/api/v1/badges/b366fc0d-c20f-4312-a573-b3de6fa243fc/deploy-status)](https://app.netlify.com/sites/researchsoft/deploys) This repository contains the source files that generates the Research Software Alliance website. The repository is monitored by From efd3a8f6fb5b86a188eb479a0c4e1f7a02d795b6 Mon Sep 17 00:00:00 2001 From: Jyoti Bhogal Date: Wed, 20 Nov 2024 12:56:19 +0530 Subject: [PATCH 20/23] resolve more broken links --- readme.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/readme.md b/readme.md index c5fd4d7f..82ea1562 100644 --- a/readme.md +++ b/readme.md @@ -11,8 +11,7 @@ website. The website uses the [Hugo framework](https://gohugo.io/) with the [Syna theme](https://about.okkur.org/syna/docs/). All content files are written -in Markdown and are processed into HTML by [Netlify]( -sites/researchsoft/deploys). +in Markdown and are processed into HTML by [Netlify](https://app.netlify.com/sites/researchsoft/deploys). ## Editing content @@ -67,8 +66,7 @@ request reviews where required. The only files that should be edited as a matter of course are in [content](https://github.com/researchsoft/website/tree/master/content). -Images generally go into [static/images] -(). +Images generally go into [static/images](https://github.com/researchsoft/website/tree/master/static/images). When editing existing content, it is possible to use the GitHub text editor interface to make changes. When viewing the file you would like to edit, click @@ -83,5 +81,4 @@ changing the _style_ of the website will require pulling this entire repo to a computer and building the site with hugo-extended. The resulting files generated in [resources/_gen/assets/scss/styles] -(< -scss/styles>) then need to be committed back to the repository. +(<) then need to be committed back to the repository. From d91d240fa99a2749c6302b131022a84a2f5eef3c Mon Sep 17 00:00:00 2001 From: Jyoti Bhogal Date: Wed, 20 Nov 2024 12:57:58 +0530 Subject: [PATCH 21/23] resolve broken link for sytles --- readme.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/readme.md b/readme.md index 82ea1562..cbb65ac2 100644 --- a/readme.md +++ b/readme.md @@ -80,5 +80,4 @@ Due to limitations in the version of Hugo that Netlify runs, changing the _style_ of the website will require pulling this entire repo to a computer and building the site with hugo-extended. The resulting files generated in -[resources/_gen/assets/scss/styles] -(<) then need to be committed back to the repository. +[resources/_gen/assets/scss/styles](https://github.com/researchsoft/website/tree/master/resources/_gen/assets/scss/styles>) then need to be committed back to the repository. From b3c8d587f0261bc1248ebd807641c2bc758d132e Mon Sep 17 00:00:00 2001 From: Jyoti Bhogal Date: Wed, 20 Nov 2024 13:02:21 +0530 Subject: [PATCH 22/23] resolve broken links --- CONTRIBUTING.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dbc6fb3d..22111f9f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,8 +8,7 @@ on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. This guide is inspired from -[Atom's contributing guidelines]( -CONTRIBUTING.md). +[Atom's contributing guidelines](https://github.com/atom/atom/blob/master/CONTRIBUTING.md). ## How Can I Contribute? @@ -32,8 +31,7 @@ issue in the body of your new one. #### Before Submitting A Bug Report * **Perform a -[cursory search]( -issues?q=is%3Aopen+is%3Aissue)** to see if the problem has already been +[cursory search](https://github.com/researchsoft/website/issues?q=is%3Aopen+is%3Aissue)** to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one. @@ -41,9 +39,7 @@ existing issue instead of opening a new one. Bugs are tracked as GitHub issues. To report a bug, create an issue in the [website repository](https://github.com/researchsoft/website) by filling in the -[bug report template]( -new?assignees=&labels=bug%2Cneeds+triage&projects=& -template=bug_report.yaml&title=BUG%3A+). +[bug report template](https://github.com/researchsoft/website//issues/new?assignees=&labels=bug%2Cneeds+triage&projects=&template=bug_report.yaml&title=BUG%3A+). Explain the problem and include additional details to help maintainers reproduce the problem: From 6fd2a4b4f1d631f541e37be4ea9fede1e78ac2a1 Mon Sep 17 00:00:00 2001 From: Jyoti Bhogal Date: Fri, 27 Dec 2024 17:54:40 +0530 Subject: [PATCH 23/23] Delete .github/workflows/markdownlint-cli2.yml --- .github/workflows/markdownlint-cli2.yml | 27 ------------------------- 1 file changed, 27 deletions(-) delete mode 100644 .github/workflows/markdownlint-cli2.yml diff --git a/.github/workflows/markdownlint-cli2.yml b/.github/workflows/markdownlint-cli2.yml deleted file mode 100644 index 1283c0bd..00000000 --- a/.github/workflows/markdownlint-cli2.yml +++ /dev/null @@ -1,27 +0,0 @@ -name: Markdown Lint - -on: - # This triggers the workflow when pushing or pulling changes to any branch - push: - branches: - - '**' - pull_request: - branches: - - '**' - -jobs: - lint-markdown: - runs-on: ubuntu-latest - - steps: - # Checkout the repository - - name: Checkout code - uses: actions/checkout@v3 - - # Run markdownlint on the specified files - - name: Lint markdown files - uses: DavidAnson/markdownlint-cli2-action@v17 - with: - globs: | - readme.md - CONTRIBUTING.md