GitBook: [#41] Fix typo to test sync

JabRef · Jan 21, 2022 · 2a8a7f0 · 2a8a7f0
1 parent 2f9506d
commit 2a8a7f0
Show file tree

Hide file tree

Showing 54 changed files with 1,719 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,52 @@
+# Overview on Developing
+
+This page presents all development information around JabRef.
+
+## Starting point for newcomers
+
+Go to [Setting up a local workspace](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace)
+
+## User documentation
+
+For users documentation, please head to [https://docs.jabref.org](https://docs.jabref.org).
+
+## How tos
+
+* External: [Sync your fork with the JabRef repository](https://help.github.com/articles/syncing-a-fork/)
+* External (🇩🇪): Branches and pull requests: [https://github.com/unibas-marcelluethi/software-engineering/blob/master/docs/week2/exercises/practical-exercises.md](https://github.com/unibas-marcelluethi/software-engineering/blob/master/docs/week2/exercises/practical-exercises.md)
+
+## Teaching Exercises
+
+We are very happy that JabRef is part of [Software Engineering](https://en.wikipedia.org/wiki/Software\_engineering) trainings. Please head to [Teaching](docs/teaching.md) for more information on using JabRef as a teaching object and on previous courses where JabRef was used.
+
+## Miscellaneous Hints
+
+### Command Line
+
+The package `org.jabref.cli` is responsible for handling the command line options.
+
+During development, one can configure IntelliJ to pass command line parameters:
+
+![IntelliJ-run-configuration](<docs/.gitbook/assets/intellij-run-configuration-command-line (2) (2) (3).png>)
+
+Passing command line arguments using gradle is currently not possible as all arguments (such as `-Dfile.encoding=windows-1252`) are passed to the application.
+
+Without jlink, it is not possible to generate a fat jar any more. During development, the capabilities of the IDE has to be used.
+
+### Groups
+
+Diagram showing aspects of groups: [Groups.uml](https://github.com/JabRef/jabref/tree/3b3716b1e05a0d3273c886e102a8efe5e96472e0/docs/Groups.uml).
+
+## Architectural Decision Records
+
+[Architectural decisions for JabRef](docs/adr.md) are recorded.
+
+For new ADRs, please use [template.md](https://github.com/JabRef/jabref/tree/3b3716b1e05a0d3273c886e102a8efe5e96472e0/docs/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). Add them to the [list of architectural decision records](docs/adr.md).
+
+## FAQ
+
+*   Q: I get `java: package org.jabref.logic.journals does not exist`.
+
+    A: You have to ignore `buildSrc/src/main` as source directory in IntelliJ as indicated in our [setup guide](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace).
+
+    Also filed as IntelliJ issue [IDEA-240250](https://youtrack.jetbrains.com/issue/IDEA-240250).
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -0,0 +1,21 @@
+# Table of contents
+
+* [Overview on Developing](README.md)
+* [Contributing](docs/contributing.md)
+* [Architectural Decisions](docs/adr.md)
+* [Getting into the code](docs/getting-into-the-code/README.md)
+  * [Set up a local workspace](docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace.md)
+  * [High-level documentation](docs/getting-into-the-code/high-level-documentation.md)
+  * [How to test](docs/getting-into-the-code/testing.md)
+  * [Code Howtos](docs/getting-into-the-code/code-howtos.md)
+  * [JabRef's development strategy](docs/getting-into-the-code/development-strategy.md)
+* [Advanced reading](docs/advanced-reading/README.md)
+  * [Code Quality](docs/advanced-reading/code-quality.md)
+  * [Recommendations for UI design](docs/advanced-reading/ui-recommendations.md)
+  * [Custom SVG icons](docs/advanced-reading/custom-svg-icons.md)
+  * [Working on fetchers](docs/advanced-reading/fetchers.md)
+  * [Creating a binary and debug it](docs/advanced-reading/jpackage.md)
+* [JabRef and Software Engineering Training](docs/teaching.md)
+* [Readings on Coding](docs/readings-on-coding/README.md)
+  * [Readings on JavaFX](docs/readings-on-coding/javafx.md)
+  * [Useful development tooling](docs/readings-on-coding/tools.md)
diff --git a/docs/.gitbook/assets/contribution-process-reviews (2) (2) (2) (2) (2) (3).svg b/docs/.gitbook/assets/contribution-process-reviews (2) (2) (2) (2) (2) (3).svg
diff --git a/...ts/contribution-process-reviews-with-instructor (1) (2) (2) (2) (2) (2) (3).svg b/...ts/contribution-process-reviews-with-instructor (1) (2) (2) (2) (2) (2) (3).svg
diff --git a/docs/.gitbook/assets/eclipse-create-run-config (1) (3) (3) (4) (4) (3) (1).png b/docs/.gitbook/assets/eclipse-create-run-config (1) (3) (3) (4) (4) (3) (1).png
diff --git a/docs/.gitbook/assets/eclipse-create-run-config (1) (3) (3) (4) (4) (3) (10).png b/docs/.gitbook/assets/eclipse-create-run-config (1) (3) (3) (4) (4) (3) (10).png
diff --git a/docs/.gitbook/assets/eclipse-create-run-config (1) (3) (3) (4) (4) (3) (11).png b/docs/.gitbook/assets/eclipse-create-run-config (1) (3) (3) (4) (4) (3) (11).png
diff --git a/docs/.gitbook/assets/eclipse-create-run-config (1) (3) (3) (4) (4) (3) (2).png b/docs/.gitbook/assets/eclipse-create-run-config (1) (3) (3) (4) (4) (3) (2).png
diff --git a/docs/.gitbook/assets/eclipse-create-run-config (1) (3) (3) (4) (4) (3) (3).png b/docs/.gitbook/assets/eclipse-create-run-config (1) (3) (3) (4) (4) (3) (3).png
diff --git a/docs/.gitbook/assets/eclipse-create-run-config (1) (3) (3) (4) (4) (3) (4).png b/docs/.gitbook/assets/eclipse-create-run-config (1) (3) (3) (4) (4) (3) (4).png
diff --git a/docs/.gitbook/assets/eclipse-create-run-config (1) (3) (3) (4) (4) (3) (5).png b/docs/.gitbook/assets/eclipse-create-run-config (1) (3) (3) (4) (4) (3) (5).png
diff --git a/docs/.gitbook/assets/eclipse-create-run-config (1) (3) (3) (4) (4) (3) (6).png b/docs/.gitbook/assets/eclipse-create-run-config (1) (3) (3) (4) (4) (3) (6).png
diff --git a/docs/.gitbook/assets/eclipse-create-run-config (1) (3) (3) (4) (4) (3) (7).png b/docs/.gitbook/assets/eclipse-create-run-config (1) (3) (3) (4) (4) (3) (7).png
diff --git a/docs/.gitbook/assets/eclipse-create-run-config (1) (3) (3) (4) (4) (3) (8).png b/docs/.gitbook/assets/eclipse-create-run-config (1) (3) (3) (4) (4) (3) (8).png
diff --git a/docs/.gitbook/assets/eclipse-create-run-config (1) (3) (3) (4) (4) (3) (9).png b/docs/.gitbook/assets/eclipse-create-run-config (1) (3) (3) (4) (4) (3) (9).png
diff --git a/docs/.gitbook/assets/eclipse-create-run-config (1) (3) (3) (4) (4) (3).png b/docs/.gitbook/assets/eclipse-create-run-config (1) (3) (3) (4) (4) (3).png
diff --git a/docs/.gitbook/assets/grafik.png b/docs/.gitbook/assets/grafik.png
diff --git a/docs/.gitbook/assets/intellij-checkstyle-settings (1).png b/docs/.gitbook/assets/intellij-checkstyle-settings (1).png
diff --git a/docs/.gitbook/assets/intellij-checkstyle-settings.png b/docs/.gitbook/assets/intellij-checkstyle-settings.png
diff --git a/...gitbook/assets/intellij-choose-jdk-adoptopenjdk-on-windows-project-settings.png b/...gitbook/assets/intellij-choose-jdk-adoptopenjdk-on-windows-project-settings.png
diff --git a/docs/.gitbook/assets/intellij-choose-jdk15-project-default.png b/docs/.gitbook/assets/intellij-choose-jdk15-project-default.png
diff --git a/docs/.gitbook/assets/intellij-enable-annotation-processing (1).png b/docs/.gitbook/assets/intellij-enable-annotation-processing (1).png
diff --git a/docs/.gitbook/assets/intellij-enable-annotation-processing.png b/docs/.gitbook/assets/intellij-enable-annotation-processing.png
diff --git a/docs/.gitbook/assets/intellij-gradle-config (1).png b/docs/.gitbook/assets/intellij-gradle-config (1).png
diff --git a/docs/.gitbook/assets/intellij-gradle-config-ignore-buildSrc (1) (1).png b/docs/.gitbook/assets/intellij-gradle-config-ignore-buildSrc (1) (1).png
diff --git a/docs/.gitbook/assets/intellij-gradle-config-ignore-buildSrc (1).png b/docs/.gitbook/assets/intellij-gradle-config-ignore-buildSrc (1).png
diff --git a/...k/assets/intellij-gradle-config-ignore-buildSrc (2) (2) (2) (3) (3) (6) (4).png b/...k/assets/intellij-gradle-config-ignore-buildSrc (2) (2) (2) (3) (3) (6) (4).png
diff --git a/docs/.gitbook/assets/intellij-gradle-config.png b/docs/.gitbook/assets/intellij-gradle-config.png
diff --git a/docs/.gitbook/assets/intellij-run-configuration-command-line (2) (2) (1).png b/docs/.gitbook/assets/intellij-run-configuration-command-line (2) (2) (1).png
diff --git a/docs/.gitbook/assets/intellij-run-configuration-command-line (2) (2) (2).png b/docs/.gitbook/assets/intellij-run-configuration-command-line (2) (2) (2).png
diff --git a/docs/.gitbook/assets/intellij-run-configuration-command-line (2) (2) (3).png b/docs/.gitbook/assets/intellij-run-configuration-command-line (2) (2) (3).png
diff --git a/docs/.gitbook/assets/intellij-run-configuration-command-line (2) (2) (4).png b/docs/.gitbook/assets/intellij-run-configuration-command-line (2) (2) (4).png
diff --git a/docs/.gitbook/assets/intellij-run-configuration-command-line (2) (2).png b/docs/.gitbook/assets/intellij-run-configuration-command-line (2) (2).png
diff --git a/docs/.gitbook/assets/intellij-wrap-at-right-margin (4) (4) (4) (1).png b/docs/.gitbook/assets/intellij-wrap-at-right-margin (4) (4) (4) (1).png