Add reference to javadoc

Squash commits of branch feature/javadoc:

- Add reference to javadoc
- Sort and update navigation
- Fix spelling and link to js styleguide
This commit is contained in:
Florian Scholdei
2025-02-14 13:49:48 +01:00
parent a83f8f015c
commit b743e74f90
4 changed files with 26 additions and 16 deletions

View File

@@ -60,15 +60,15 @@ gradlew.bat taskname
This following tables describes some high level tasks,
which should cover most of the daily work.
| Name | Description |
| ---- | ----------- |
| run | Starts an SCM-Manager with enabled livereload for the ui |
| build | Executes all checks, tests and builds the smp inclusive javadoc and source jar |
| distribution | Builds all distribution packages of scm-packaging |
| check | Executes all registered checks and tests |
| test | Run all unit tests |
| integrationTest | Run all integration tests of scm-it |
| clean | Deletes the build directory |
| Name | Description |
| ---- |--------------------------------------------------------------------------------------------------------------------|
| run | Starts an SCM-Manager with enabled livereload for the ui |
| build | Executes all checks, tests and builds the smp inclusive [javadoc](https://scm-manager.org/javadoc/) and source jar |
| distribution | Builds all distribution packages of scm-packaging |
| check | Executes all registered checks and tests |
| test | Run all unit tests |
| integrationTest | Run all integration tests of scm-it |
| clean | Deletes the build directory |
The next table defines a few more tasks which are more relevant for CI servers.

View File

@@ -0,0 +1,5 @@
---
title: Javadoc
---
You can find the Javadoc at [javadoc](https://scm-manager.org/javadoc/).

View File

@@ -1,5 +1,5 @@
---
title: Style Guide
title: Styleguide
---
Starting with version 2 of SCM-Manager we have decided to change the code style and conform to more common rules. Furthermore we abandon the rule, that everything needs to have a javadoc description. Nonetheless we have decided against a "big bang" adaption of the new rule, because this would have lead to enourmous problems for merges from 1.x to 2.x.
@@ -107,4 +107,4 @@ more skill. If you feel overwhelmed by them, do not let them deter you. We love
## JavaScript
Take a look at our styleguide using `yarn serve` in [ui-styles](scm-ui/ui-styles) directory.
Take a look at our styleguide using `yarn serve` in `/scm-ui/ui-styles` directory.

View File

@@ -31,16 +31,21 @@
entries:
- /development/intellij-idea-configuration/
- /development/build-from-source/
- /development/architecture-overview/
- /development/ui-common-pitfall/
- /development/permission-concept/
- /development/error-handling/
- /development/i18n/
- /development/definition-of-done/
- /development/ui-dod/
- /development/decision-table/
- /development/building-forms/
- /development/error-handling/
- /development/styleguide/
- /development/testing-guide/
- /development/integration-tests/
- /development/ui-extensions/
- /development/i18n/
- /development/building-forms/
- /development/javadoc/
- /development/cli-guideline/
- /development/definition-of-done/
- /development/ui-dod/
- section: Plugin Development
entries: