Skip to content

Commit b450152

Browse files
committed
partial documentation update for workflows for updating documentation
1 parent b1f91b1 commit b450152

File tree

3 files changed

+13
-20
lines changed

3 files changed

+13
-20
lines changed

.github/workflows/check-links.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Check external href links in the documentation
1+
name: Check links
22

33
on:
44
push:
-107 KB
Binary file not shown.

en/contributing/how-to-improve-the-help-page.md

Lines changed: 12 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -54,35 +54,28 @@ That's it! The JabRef team will review your changes and publish them on [docs.ja
5454

5555
To edit more than one file at a time, add screenshots, and for other more advanced changes, we recommend that you checkout this repository locally and create a Pull Request of your changes using the standard git and GitHub workflow.
5656

57-
### Tables
57+
### Github workflows
5858

59-
The best way to enter tables is to use this [Table Generator](http://www.tablesgenerator.com/markdown\_tables) for Markdown. It has the nice feature to generate markdown tables from different sources, e.g. you can directly copy the table from a spreadsheet or upload a csv file. Just copy and paste the generated markdown into the documentation.
59+
In order to find broken links and find Markdown errors, you can use the "Check Links" and "Lint" workflows respectively. These are provided in `.github/workflows` and run each time you push to the documentation repo. You are recommended to check the results of these workflows on your local fork after pushing changes to it to catch minor mistakes.
60+
- Lint workflow checks for minor Markdown formatting style issues.
61+
- Check links workflow checks for broken links, e.g. to images or external resources.
6062

61-
### How to regenerate `SUMMARY.md` from scratch
63+
On your local fork, you can check the results of the workflows in the Actions tab > All actions panel on Github as shown below. Click on a specific workflow and its run to check it.
6264

63-
Use <https://github.com/koppor/gitbook-summary-generator>.
65+
### Notes on links workflow
6466

65-
### How to find broken links
67+
Links to external resources that aren't essential should be added to `.lycheeignore`. Resources can change URL or be taken down, and it isn't the best use of contributor resources to constantly keep fixing them, so try to spare us the headache!
6668

67-
1. Install [markdown-link-check](https://github.com/tcort/markdown-link-check): `npm install -g markdown-link check`
68-
2. `find . -name \*.md -exec markdown-link-check -qq {} \; > bad-links.txt`
69+
Note that check links may fail on links which you did not modify in your changes, in which case you can ignore them. Just do make sure that you don't introduce any additional broken links.
6970

70-
### How to find Markdown errors
71+
### Tables
7172

72-
You can use the [markdown-lint docker image](https://github.com/marketplace/actions/markdown-linting-action):
73+
The best way to enter tables is to use this [Table Generator](http://www.tablesgenerator.com/markdown\_tables) for Markdown. It has the nice feature to generate markdown tables from different sources, e.g. you can directly copy the table from a spreadsheet or upload a csv file. Just copy and paste the generated markdown into the documentation.
7374

74-
```shell
75-
docker run --rm \
76-
-v "$(pwd):/tmp/check" \
77-
-e INPUT_CONFIG=/tmp/check/.markdownlint.yml \
78-
avtodev/markdown-lint:v1 \
79-
/tmp/check/en
80-
```
75+
### How to regenerate `SUMMARY.md` from scratch
8176

82-
Alternatively, you can run the GitHub Lint workflow:
77+
Use <https://github.com/koppor/gitbook-summary-generator>.
8378

84-
```shell
85-
act --rm --platform ubuntu-latest=fwilhe2/act-runner:latest -W .github/workflows/lint.yaml
8679
```
8780
8881
## Run workflows through Github

0 commit comments

Comments
 (0)