From bece2d1f784283206d948e44e6872ff8550a76e9 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Mon, 25 May 2020 17:21:34 +0200 Subject: [PATCH 01/11] Add markdown checks (and fix some markdown issues) --- .github/workflows/tests.yml | 21 ++++++++++++++ .markdownlint.yml | 18 ++++++++++++ CHANGELOG.md | 5 ++-- docs/adr/0004-use-mariadb-connector.md | 1 + ...nly-translated-strings-in-language-file.md | 1 + docs/adr/template.md | 28 +++++++++---------- docs/code-howtos.md | 3 +- docs/javafx.md | 2 +- docs/teaching.md | 11 ++++---- mlc_config.json | 10 +++++++ 10 files changed, 77 insertions(+), 23 deletions(-) create mode 100644 .markdownlint.yml create mode 100644 mlc_config.json diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 572c836fe90..0244224a31e 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -216,3 +216,24 @@ jobs: steps: - uses: actions/checkout@v2 - uses: gradle/wrapper-validation-action@v1 + markdown-link-check: + runs-on: ubuntu-latest + steps: + - name: Set up Git repository + uses: actions/checkout@v2 + - uses: gaurav-nelson/github-action-markdown-link-check@v1 + with: + use-quiet-mode: 'yes' + use-verbose-mode: 'yes' + config-file: 'mlc_config.json' + folder-path: 'docs/' + markdown-lint-check: + runs-on: ubuntu-latest + steps: + - name: Set up Git repository + uses: actions/checkout@v2 + - name: Lint all files + uses: avto-dev/markdown-lint@v1 + with: + args: 'docs/ CHANGELOG.md README.md' + config: '.markdownlint.yml' diff --git a/.markdownlint.yml b/.markdownlint.yml new file mode 100644 index 00000000000..84a9c96a53a --- /dev/null +++ b/.markdownlint.yml @@ -0,0 +1,18 @@ +default: true + +# Using h2 has side effects in GitBook's toc. Thus, we sometimes switch from h1 to h3 +MD001: false + +MD012: + # 2 are required, because GitBook adss two blank lines at the end of a file + maximum: 2 + +MD013: false + +# The FAQs state questions - we allow them +MD026: + punctuation: ".,;:!" + +MD033: + # we have tags with ids + allowed_elements: ['a'] diff --git a/CHANGELOG.md b/CHANGELOG.md index 48e1767b555..da4e2fe90b1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -127,6 +127,7 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve - We fixed an issue where the blue and red text colors in the Merge entries dialog were not quite visible [#6334](https://github.com/JabRef/jabref/issues/6334) - We fixed an issue where underscore character was removed from the file name in the Recent Libraries list in File menu [#6383](https://github.com/JabRef/jabref/issues/6383) - We fixed an issue where few keyboard shortcuts regarding new entries were missing [#6403](https://github.com/JabRef/jabref/issues/6403) + ### Removed - Ampersands are no longer escaped by default in the `bib` file. If you want to keep the current behaviour, you can use the new "Escape Ampersands" formatter as a save action. [#5869](https://github.com/JabRef/jabref/issues/5869) @@ -302,8 +303,8 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve - We fixed an issue where some journal names were wrongly marked as abbreviated. [#4115](https://github.com/JabRef/jabref/issues/4115) - We fixed an issue where the custom file column were sorted incorrectly. [#3119](https://github.com/JabRef/jabref/issues/3119) - We improved the parsing of author names whose infix is abbreviated without a dot. [#4864](https://github.com/JabRef/jabref/issues/4864) -- We fixed an issues where the entry losses focus when a field is edited and at the same time used for sorting. https://github.com/JabRef/jabref/issues/3373 -- We fixed an issue where the menu on Mac OS was not displayed in the usual Mac-specific way. https://github.com/JabRef/jabref/issues/3146 +- We fixed an issues where the entry losses focus when a field is edited and at the same time used for sorting. [#3373](https://github.com/JabRef/jabref/issues/3373) +- We fixed an issue where the menu on Mac OS was not displayed in the usual Mac-specific way. [#3146](https://github.com/JabRef/jabref/issues/3146) - We improved the integrity check for page numbers. [#4113](https://github.com/JabRef/jabref/issues/4113) and [feature request in the forum](http://discourse.jabref.org/t/pages-field-allow-use-of-en-dash/1199) - We fixed an issue where the order of fields in customized entry types was not saved correctly. [#4033](http://github.com/JabRef/jabref/issues/4033) - We fixed an issue where renaming a group did not change the group name in the interface. [#3189](https://github.com/JabRef/jabref/issues/3189) diff --git a/docs/adr/0004-use-mariadb-connector.md b/docs/adr/0004-use-mariadb-connector.md index 2085113a0a3..31b4b6604d6 100644 --- a/docs/adr/0004-use-mariadb-connector.md +++ b/docs/adr/0004-use-mariadb-connector.md @@ -30,3 +30,4 @@ The [MySQL Connector](https://www.mysql.com/de/products/connector/) is distribut * Good, because it stems from the same development team than MySQL * Bad, because the "Universal FOSS Exception" makes licensing more complicated. + diff --git a/docs/adr/0006-only-translated-strings-in-language-file.md b/docs/adr/0006-only-translated-strings-in-language-file.md index 1aada8966eb..2fd3ccfbc16 100644 --- a/docs/adr/0006-only-translated-strings-in-language-file.md +++ b/docs/adr/0006-only-translated-strings-in-language-file.md @@ -44,3 +44,4 @@ Chosen option: "Only translated strings in language file", because comes out bes * Related to [ADR-0001](0001-use-crowdin-for-translations.md). + diff --git a/docs/adr/template.md b/docs/adr/template.md index 22d77697e71..967496d27fb 100644 --- a/docs/adr/template.md +++ b/docs/adr/template.md @@ -1,10 +1,10 @@ # \[short title of solved problem and solution\] -* Status: \[proposed \| rejected \| accepted \| deprecated \| … \| superseded by [ADR-0005](https://github.com/JabRef/jabref/tree/8c07a88a823a84aebe987cdb717f318ed00a872d/docs/adr/0005-example.md)\] -* Deciders: \[list everyone involved in the decision\] -* Date: \[YYYY-MM-DD when the decision was last updated\] +* Status: \[proposed \| rejected \| accepted \| deprecated \| … \| superseded by [ADR-0005](https://github.com/JabRef/jabref/tree/8c07a88a823a84aebe987cdb717f318ed00a872d/docs/adr/0005-example.md)\] +* Deciders: \[list everyone involved in the decision\] +* Date: \[YYYY-MM-DD when the decision was last updated\] -Technical Story: \[description \| ticket/issue URL\] +Technical Story: \[description \| ticket/issue URL\] ## Context and Problem Statement @@ -14,14 +14,14 @@ Technical Story: \[description \| ticket/issue URL\] * \[driver 1, e.g., a force, facing concern, …\] * \[driver 2, e.g., a force, facing concern, …\] -* … +* … ## Considered Options * \[option 1\] * \[option 2\] * \[option 3\] -* … +* … ## Decision Outcome @@ -41,33 +41,33 @@ Chosen option: "\[option 1\]", because \[justification. e.g., only option, which ### \[option 1\] -\[example \| description \| pointer to more information \| …\] +\[example \| description \| pointer to more information \| …\] * Good, because \[argument a\] * Good, because \[argument b\] * Bad, because \[argument c\] -* … +* … ### \[option 2\] -\[example \| description \| pointer to more information \| …\] +\[example \| description \| pointer to more information \| …\] * Good, because \[argument a\] * Good, because \[argument b\] * Bad, because \[argument c\] -* … +* … ### \[option 3\] -\[example \| description \| pointer to more information \| …\] +\[example \| description \| pointer to more information \| …\] * Good, because \[argument a\] * Good, because \[argument b\] * Bad, because \[argument c\] -* … +* … ## Links -* \[Link type\] \[Link to ADR\] -* … +* \[Link type\] \[Link to ADR\] +* … diff --git a/docs/code-howtos.md b/docs/code-howtos.md index 9e747de41ea..7897fce41d1 100644 --- a/docs/code-howtos.md +++ b/docs/code-howtos.md @@ -30,6 +30,7 @@ Principles: Localization.lang("Something went wrong...", ioe); } ``` + * Never, ever throw and catch `Exception` or `Throwable` * Errors should only be logged when they are finally caught \(i.e., logged only once\). See **Logging** for details. * If the Exception message is intended to be shown to the User in the UI \(see below\) provide also a localizedMessage \(see `JabRefException`\). @@ -45,7 +46,7 @@ To show error message two different ways are usually used in JabRef: * showing an error dialog * updating the status bar at the bottom of the main window -_TODO: Usage of status bar and Swing Dialogs_ +_*TODO: Usage of status bar and Swing Dialogs*_ ## Using the EventSystem diff --git a/docs/javafx.md b/docs/javafx.md index 06721363efa..2cab20d1033 100644 --- a/docs/javafx.md +++ b/docs/javafx.md @@ -7,7 +7,7 @@ JabRef's recommendations about JavaFX The goal of the MVVM architecture is to separate the state/behavior from the appearance of the ui. This is archived by dividing JabRef into different layers, each having a clear responsibility. * The _Model_ contains the business logic and data structures. These aspects are again encapsulated in the _logic_ and _model_ package, respectively. -* The _View_ controls the appearance and structure of the UI. It is usually defined in a _FXML_ file. +* The _View_ controls the appearance and structure of the UI. It is usually defined in a _FXML_ file. * _View model_ converts the data from logic and model in a form that is easily usable in the gui. Thus it controls the state of the View. Moreover, the ViewModel contains all the logic needed to change the current state of the UI or perform an action. These actions are usually passed down to the _logic_ package, after some data validation. The important aspect is that the ViewModel contains all the ui-related logic but does _not_ have direct access to the controls defined in the View. Hence, the ViewModel can easily be tested by unit tests. * The _Controller_ initializes the view model and binds it to the view. In an ideal world all the binding would already be done directly in the FXML. But JavaFX's binding expressions are not yet powerful enough to accomplish this. It is important to keep in mind that the Controller should be as minimalistic as possible. Especially one should resist the temptation to validate inputs in the controller. The ViewModel should handle data validation! It is often convenient to load the FXML file directly from the controller. diff --git a/docs/teaching.md b/docs/teaching.md index a6e9c6726f8..41720ce09d7 100644 --- a/docs/teaching.md +++ b/docs/teaching.md @@ -69,7 +69,7 @@ Course: Open Source Software Development Course [CS499 - Open Source Software Development](https://github.com/igorsteinmacher/CS499-OSS) -- Summary: Students experience the process of getting involved in an Open Source project by engaging with a real project. Their goal is to make a "substantial" contribution to a project. +- Summary: Students experience the process of getting involved in an Open Source project by engaging with a real project. Their goal is to make a "substantial" contribution to a project. - Course offered in 2018 ### German @@ -122,12 +122,13 @@ Course [Open Source Software](https://github.com/igorsteinmacher/DSL-UTFPR) ## Interesting Read for Students and Advisors -- [Developing Procrastination Feedback for Student Software Developers](https://medium.com/@ayaankazerouni/developing-procrastination-feedback-for-student-software-developers-1652de60db7f) by [@ayaankazerouni](https://github.com/ayaankazerouni?tab=overview&from=2015-12-01&to=2015-12-31) +- [Developing Procrastination Feedback for Student Software Developers](https://medium.com/@ayaankazerouni/developing-procrastination-feedback-for-student-software-developers-1652de60db7f) by [@ayaankazerouni](https://github.com/ayaankazerouni?tab=overview&from=2015-12-01&to=2015-12-31) + > When students worked earlier and more often, they produced projects that: > - > - were more correct, - > - were completed earlier, - > - took no more or less time to complete + > - were more correct, + > - were completed earlier, + > - took no more or less time to complete ## References diff --git a/mlc_config.json b/mlc_config.json new file mode 100644 index 00000000000..a48a016d213 --- /dev/null +++ b/mlc_config.json @@ -0,0 +1,10 @@ +{ + "ignorePatterns": [ + { + "pattern": "^https://dl\\.acm\\.org" + }, + { + "pattern": "^http://purl\\.org/net/bibteXMP" + } + ] +} From 9af8b5e74b1bb20d5cd6932b57d72c9233459a11 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Tue, 26 May 2020 00:14:20 +0200 Subject: [PATCH 02/11] Add markown linting things to checkstyle --- .github/workflows/tests.yml | 33 ++++++++++++--------------------- 1 file changed, 12 insertions(+), 21 deletions(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 0244224a31e..ea5dfafaec1 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -37,6 +37,18 @@ jobs: key: ${{ runner.os }}-gradle-${{ hashFiles('gradle/wrapper/gradle-wrapper.properties') }} - name: Run checkstyle run: ./gradlew checkstyleMain checkstyleTest checkstyleJmh + - name: Run markdown-link-check + uses: gaurav-nelson/github-action-markdown-link-check@v1 + with: + use-quiet-mode: 'yes' + use-verbose-mode: 'yes' + config-file: 'mlc_config.json' + folder-path: 'docs/' + - name: Run markdown-lint + uses: avto-dev/markdown-lint@v1 + with: + args: 'docs/ CHANGELOG.md README.md' + config: '.markdownlint.yml' tests: name: Unit tests runs-on: ubuntu-latest @@ -216,24 +228,3 @@ jobs: steps: - uses: actions/checkout@v2 - uses: gradle/wrapper-validation-action@v1 - markdown-link-check: - runs-on: ubuntu-latest - steps: - - name: Set up Git repository - uses: actions/checkout@v2 - - uses: gaurav-nelson/github-action-markdown-link-check@v1 - with: - use-quiet-mode: 'yes' - use-verbose-mode: 'yes' - config-file: 'mlc_config.json' - folder-path: 'docs/' - markdown-lint-check: - runs-on: ubuntu-latest - steps: - - name: Set up Git repository - uses: actions/checkout@v2 - - name: Lint all files - uses: avto-dev/markdown-lint@v1 - with: - args: 'docs/ CHANGELOG.md README.md' - config: '.markdownlint.yml' From 9f544c231f3a2b6fa0572b17248fc25a1f49b5ad Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Wed, 27 May 2020 22:58:20 +0200 Subject: [PATCH 03/11] Fix links --- docs/README.md | 2 +- docs/adr/template.md | 2 +- docs/code-howtos.md | 2 +- docs/code-quality.md | 2 +- docs/guidelines-for-setting-up-a-local-workspace.md | 2 +- docs/javafx.md | 6 +++--- docs/jpackage.md | 2 +- mlc_config.json | 3 +++ 8 files changed, 12 insertions(+), 9 deletions(-) diff --git a/docs/README.md b/docs/README.md index 4287ad7e8d9..e65ae522f1d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -42,7 +42,7 @@ This log lists the decisions for JabRef. * [ADR-0007](adr/0007-human-readable-changelog.md) - Provide a human-readable changelog * [ADR-0008](adr/0008-use-public-final-instead-of-getters.md) - Use public final instead of getters to offer access to immutable variables * [ADR-0009](adr/0009-use-plain-junit5-for-testing.md) - Use Plain JUnit5 for advanced test assertions -* [ADR-0010](0010-use-h2-as-internal-database.md) - Use H2 as Internal SQL Database +* [ADR-0010](adr/0010-use-h2-as-internal-database.md) - Use H2 as Internal SQL Database For new ADRs, please use [template.md](adr/template.md) as basis. More information on MADR is available at [https://adr.github.io/madr/](https://adr.github.io/madr/). General information about architectural decision records is available at [https://adr.github.io/](https://adr.github.io/). diff --git a/docs/adr/template.md b/docs/adr/template.md index 967496d27fb..b07f46e2eb0 100644 --- a/docs/adr/template.md +++ b/docs/adr/template.md @@ -1,6 +1,6 @@ # \[short title of solved problem and solution\] -* Status: \[proposed \| rejected \| accepted \| deprecated \| … \| superseded by [ADR-0005](https://github.com/JabRef/jabref/tree/8c07a88a823a84aebe987cdb717f318ed00a872d/docs/adr/0005-example.md)\] +* Status: \[proposed \| rejected \| accepted \| deprecated \| … \| superseded by [ADR-0005](0005-fully-support-utf8-only-for-latex-files.md)\] * Deciders: \[list everyone involved in the decision\] * Date: \[YYYY-MM-DD when the decision was last updated\] diff --git a/docs/code-howtos.md b/docs/code-howtos.md index 7897fce41d1..24a41b60891 100644 --- a/docs/code-howtos.md +++ b/docs/code-howtos.md @@ -180,7 +180,7 @@ The tests check whether translation strings appear correctly in the resource bun We try to build a cleanup mechanism based on formatters. The idea is that we can register these actions in arbitrary places, e.g., onSave, onImport, onExport, cleanup, etc. and apply them to different fields. The formatters themself are independent of any logic and therefore easy to test. -Example: [PageNumbersFormatter](https://github.com/JabRef/jabref/blob/master/src/main/java/net/sf/jabref/logic/formatter/bibtexfields/PageNumbersFormatter.java) +Example: [NormalizePagesFormatter](https://github.com/JabRef/jabref/blob/master/src/main/java/org/jabref/logic/formatter/bibtexfields/NormalizePagesFormatter.java) ## Drag and Drop diff --git a/docs/code-quality.md b/docs/code-quality.md index 5739c3629eb..5504010fd1f 100644 --- a/docs/code-quality.md +++ b/docs/code-quality.md @@ -8,7 +8,7 @@ We monitor the general source code quality at three places: We strongly recommend to read following two books on code quality: -* [Java by Comparison](https://github.com/JabRef/jabref/tree/c81740b3818c7f9311a6d7ff063243e672c821b4/docs/java.by-comparison.com) is a book by three JabRef developers which focuses on code improvements close to single statements. It is fast to read and one gains much information from each recommendation discussed in the book. +* [Java by Comparison](http://java.by-comparison.com) is a book by three JabRef developers which focuses on code improvements close to single statements. It is fast to read and one gains much information from each recommendation discussed in the book. * [Effective Java](https://www.oreilly.com/library/view/effective-java-3rd/9780134686097/) is the standard book for advanced Java programming. Did you know that `enum` is the [recommended way to enforce a singleton instance of a class](https://learning.oreilly.com/library/view/effective-java-3rd/9780134686097/ch2.xhtml#lev3)? Did you know that one should [refer to objects by their interfaces](https://learning.oreilly.com/library/view/effective-java-3rd/9780134686097/ch9.xhtml#lev64)? The principles we follow to ensure high code quality in JabRef is stated at our [Development Strategy](development-strategy.md). diff --git a/docs/guidelines-for-setting-up-a-local-workspace.md b/docs/guidelines-for-setting-up-a-local-workspace.md index 94faa6196e0..4cb113f54a5 100644 --- a/docs/guidelines-for-setting-up-a-local-workspace.md +++ b/docs/guidelines-for-setting-up-a-local-workspace.md @@ -59,7 +59,7 @@ It is strongly recommend that you have git installed. We suggest [IntelliJ IDEA](https://www.jetbrains.com/idea/) or [Eclipse (for advanced users)](https://eclipse.org/) \(`2020-03` or newer\). -Under Ubuntu Linux, you can follow the [documentation from the Ubuntu Community](https://help.ubuntu.com/community/EclipseIDE#Download_Eclipse) or the [step-by-step guideline from Krizna](https://github.com/JabRef/jabref/tree/be9c788de804c2bd9e3abaf76b082b6b2e82e66f/docs/www.krizna.com/ubuntu/install-eclipse-in-ubuntu-12-04/README.md) to install Eclipse. Under Windows, download it from [www.eclipse.org](http://www.eclipse.org/downloads/) and run the installer. +Under Ubuntu Linux, you can follow the [documentation from the Ubuntu Community](https://help.ubuntu.com/community/EclipseIDE#Download_Eclipse) or the [step-by-step guideline from Krizna](https://www.krizna.com/ubuntu/install-eclipse-in-ubuntu-12-04/) to install Eclipse. Under Windows, download it from [www.eclipse.org](http://www.eclipse.org/downloads/) and run the installer. ### Other Tooling diff --git a/docs/javafx.md b/docs/javafx.md index 2cab20d1033..232ad8f525e 100644 --- a/docs/javafx.md +++ b/docs/javafx.md @@ -134,14 +134,14 @@ private void openJabrefWebsite() { ### View - FXML -The view consists a FXML file `MyDialog.fxml` which defines the structure and the layout of the UI. Moreover, the FXML file may be accompanied by a style file that should have the same name as the FXML file but with a `css` ending, e.g., `MyDialog.css`. It is recommended to use a graphical design tools like [SceneBuilder](http://gluonhq.com/labs/scene-builder/) to edit the FXML file. The tool [Scenic View](http://fxexperience.com/scenic-view/) is very helpful in debugging styling issues. +The view consists a FXML file `MyDialog.fxml` which defines the structure and the layout of the UI. Moreover, the FXML file may be accompanied by a style file that should have the same name as the FXML file but with a `css` ending, e.g., `MyDialog.css`. It is recommended to use a graphical design tools like [SceneBuilder](http://gluonhq.com/labs/scene-builder/) to edit the FXML file. The tool [Scenic View](https://github.com/JonathanGiles/scenic-view) is very helpful in debugging styling issues. ## Resources * [curated list of awesome JavaFX frameworks, libraries, books and etc...](https://github.com/mhrimaz/AwesomeJavaFX) * [ControlsFX](http://fxexperience.com/controlsfx/features/) amazing collection of controls -* [usage of icon fonts with JavaFX](http://aalmiray.github.io/ikonli/#_javafx) or [jIconFont](https://github.com/jIconFont/jiconfont-google_material_design_icons) or [fontawesomefx](https://bitbucket.org/Jerady/fontawesomefx/) -* [Undo manager](https://github.com/TomasMikula/UndoFX) +* [jIconFont](http://jiconfont.github.io/googlematerialdesignicons) or [fontawesomefx](https://bitbucket.org/Jerady/fontawesomefx/) +* [Undo manager](https://github.com/FXMisc/UndoFX) * [Docking manager](https://github.com/alexbodogit/AnchorFX) [or](https://github.com/RobertBColton/DockFX) * [additional bindings](https://github.com/lestard/advanced-bindings) or [EasyBind](https://github.com/TomasMikula/EasyBind) * [Kubed](https://github.com/hudsonb/kubed): data visualization \(inspired by d3\) diff --git a/docs/jpackage.md b/docs/jpackage.md index 325970b58e9..2a6e005b9ca 100644 --- a/docs/jpackage.md +++ b/docs/jpackage.md @@ -1,6 +1,6 @@ # jpackage -JabRef uses [jpackage](https://jdk.java.net/jpackage/) to build binary distributions for Windows, Linux, and Mac OS X. +JabRef uses [jpackage](https://openjdk.java.net/jeps/343) to build binary distributions for Windows, Linux, and Mac OS X. ## Build Windows binaries locally diff --git a/mlc_config.json b/mlc_config.json index a48a016d213..43d1ec18e04 100644 --- a/mlc_config.json +++ b/mlc_config.json @@ -5,6 +5,9 @@ }, { "pattern": "^http://purl\\.org/net/bibteXMP" + }, + { + "pattern": "^http://localhost" } ] } From 01811c278b76df624e147b540e325e770881b2ff Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Wed, 27 May 2020 23:13:34 +0200 Subject: [PATCH 04/11] Remove markdown-link-check: Too many broken links --- .github/workflows/tests.yml | 7 ------- 1 file changed, 7 deletions(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index ea5dfafaec1..81df07b7e1a 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -37,13 +37,6 @@ jobs: key: ${{ runner.os }}-gradle-${{ hashFiles('gradle/wrapper/gradle-wrapper.properties') }} - name: Run checkstyle run: ./gradlew checkstyleMain checkstyleTest checkstyleJmh - - name: Run markdown-link-check - uses: gaurav-nelson/github-action-markdown-link-check@v1 - with: - use-quiet-mode: 'yes' - use-verbose-mode: 'yes' - config-file: 'mlc_config.json' - folder-path: 'docs/' - name: Run markdown-lint uses: avto-dev/markdown-lint@v1 with: From 5d6763f26ec4457b84fb4cddc73996a4823068aa Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Wed, 27 May 2020 23:26:13 +0200 Subject: [PATCH 05/11] Fix more links --- docs/code-howtos.md | 2 +- docs/guidelines-for-setting-up-a-local-workspace.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/code-howtos.md b/docs/code-howtos.md index 24a41b60891..182375b4046 100644 --- a/docs/code-howtos.md +++ b/docs/code-howtos.md @@ -139,7 +139,7 @@ JabRef uses the logging facade [SLF4j](https://www.slf4j.org/). All log messages ## Using Localization correctly -_\(More information about this topic from the translator side is provided under this link:_ [_Translating JabRef Interface_](https://github.com/JabRef/jabref/wiki/Translating-JabRef-Interface) _about the JabRef interface and_ [_Translating JabRef Help_](https://github.com/JabRef/jabref/wiki/Translating-JabRef-Help) _about the JabRef help files\)_ +More information about this topic from the translator side is provided at [Translating JabRef Interface](https://docs.jabref.org/faqcontributing/how-to-translate-the-ui). All labeled UI elements, descriptions and messages shown to the user should be localized, i.e., should be displayed in the chosen language. diff --git a/docs/guidelines-for-setting-up-a-local-workspace.md b/docs/guidelines-for-setting-up-a-local-workspace.md index 4cb113f54a5..e361109b952 100644 --- a/docs/guidelines-for-setting-up-a-local-workspace.md +++ b/docs/guidelines-for-setting-up-a-local-workspace.md @@ -74,7 +74,7 @@ This section explains how you get the JabRef code onto your machine in a form al 1. Log into your GitHub account 2. Go to [https://github.com/JabRef/jabref](https://github.com/JabRef/jabref) 3. Create a fork by clicking at fork button on the right top corner -4. A fork repository will be created under your account \([https://github.com/YOUR\_USERNAME/jabref](https://github.com/YOUR_USERNAME/jabref)\) +4. A fork repository will be created under your account `https://github.com/YOUR\_USERNAME/jabref`. ### Clone your forked repository on your local machine From 36d382fa584526131c2a9289f08ca92b08dff50a Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Wed, 27 May 2020 23:27:22 +0200 Subject: [PATCH 06/11] Try other parameter --- .github/workflows/tests.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 81df07b7e1a..2df9a4333e7 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -40,7 +40,7 @@ jobs: - name: Run markdown-lint uses: avto-dev/markdown-lint@v1 with: - args: 'docs/ CHANGELOG.md README.md' + args: '"**/*.md"' config: '.markdownlint.yml' tests: name: Unit tests From 4e165ba88d12a3fee0f9367bee8342c57cfadaef Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Wed, 27 May 2020 23:39:22 +0200 Subject: [PATCH 07/11] Try passing args correctly --- .github/workflows/tests.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 2df9a4333e7..5f910b3e5bc 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -40,7 +40,10 @@ jobs: - name: Run markdown-lint uses: avto-dev/markdown-lint@v1 with: - args: '"**/*.md"' + args: + - 'docs/' + - 'CHANGELOG.md' + - 'README.md' config: '.markdownlint.yml' tests: name: Unit tests From f4feb6d97d2d838365dfcb5c9e66c79b20b2a732 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Wed, 27 May 2020 23:53:41 +0200 Subject: [PATCH 08/11] Trying to learn YAML --- .github/workflows/tests.yml | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 5f910b3e5bc..04e7f8c931b 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -40,10 +40,7 @@ jobs: - name: Run markdown-lint uses: avto-dev/markdown-lint@v1 with: - args: - - 'docs/' - - 'CHANGELOG.md' - - 'README.md' + args: docs/ CHANGELOG.md README.md config: '.markdownlint.yml' tests: name: Unit tests From 4da953b52bbea5ac9d530296705713699b9fdd55 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Thu, 28 May 2020 00:19:46 +0200 Subject: [PATCH 09/11] Try glob pattern --- .github/workflows/tests.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 04e7f8c931b..05909a0cac4 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -40,7 +40,7 @@ jobs: - name: Run markdown-lint uses: avto-dev/markdown-lint@v1 with: - args: docs/ CHANGELOG.md README.md + args: **/*.md config: '.markdownlint.yml' tests: name: Unit tests From 4c9bba0ec9ae0d24a9582ccee2accc4946803aae Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Thu, 28 May 2020 00:26:33 +0200 Subject: [PATCH 10/11] Switch to my fork of markdown-lint GH action --- .github/workflows/tests.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 05909a0cac4..894d95fce27 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -38,9 +38,9 @@ jobs: - name: Run checkstyle run: ./gradlew checkstyleMain checkstyleTest checkstyleJmh - name: Run markdown-lint - uses: avto-dev/markdown-lint@v1 + uses: koppor/markdown-lint@master with: - args: **/*.md + args: CHANGELOG.md README.md docs/ config: '.markdownlint.yml' tests: name: Unit tests From 08bffbdd5dcf862d60fbcdedf0413a240df71634 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Thu, 28 May 2020 00:31:32 +0200 Subject: [PATCH 11/11] Fix linting issues --- CHANGELOG.md | 1 + docs/teaching.md | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 82d0795fd79..f9977c9ee26 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,7 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve ## [Unreleased] ### Added + - We added the Library properties to a context menu on the library tabs [#6485](https://github.com/JabRef/jabref/issues/6485) - We added a new field in the preferences in 'BibTeX key generator' for unwanted characters that can be user-specified. [#6295](https://github.com/JabRef/jabref/issues/6295) - We added support for searching ShortScience for an entry through the user's browser. [#6018](https://github.com/JabRef/jabref/pull/6018) diff --git a/docs/teaching.md b/docs/teaching.md index 41720ce09d7..cf3e0e9066f 100644 --- a/docs/teaching.md +++ b/docs/teaching.md @@ -126,9 +126,9 @@ Course [Open Source Software](https://github.com/igorsteinmacher/DSL-UTFPR) > When students worked earlier and more often, they produced projects that: > - > - were more correct, - > - were completed earlier, - > - took no more or less time to complete + > - were more correct, + > - were completed earlier, + > - took no more or less time to complete ## References