You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: en/contributing/how-to-improve-the-help-page.md
+12-19Lines changed: 12 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,35 +54,28 @@ That's it! The JabRef team will review your changes and publish them on [docs.ja
54
54
55
55
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.
56
56
57
-
### Tables
57
+
### Github workflows
58
58
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.
60
62
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.
62
64
63
-
Use <https://github.com/koppor/gitbook-summary-generator>.
65
+
### Notes on links workflow
64
66
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!
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.
69
70
70
-
### How to find Markdown errors
71
+
### Tables
71
72
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.
73
74
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
81
76
82
-
Alternatively, you can run the GitHub Lint workflow:
77
+
Use <https://github.com/koppor/gitbook-summary-generator>.
0 commit comments