Skip to content
GitLab
Hide whitespace changes
Inline Side-by-side
docs/unified-ticketing/contributing.md 0 → 100644
View file @ 6a13bca2
# Contributing
To contribute to this project,
you primarily have to be a member of the University of Applied Sciences Stuttgart.
This project is hosted on our Transferportal's GitLab instance,
to which only HFT members have access to my knowledge.
Apart from that, for contributing to the library code itself,
you should be able to program Java and be familiar with maven.
For the documentation you need to have Python installed and know how to write Markdown.
For all contributions you need to use Git.
For details see the [Developer Guide][dev-guide].
There you can find information about getting ready,
what rules to follow
and more developers than user based documentation about the library.
[dev-guide]: ../developers-guide/machine-setup.md
docs/unified-ticketing/license-softlink.md 0 → 120000
View file @ 6a13bca2
../../LICENSE.md
\ No newline at end of file
docs/unified-ticketing/usage.md 0 → 100644
View file @ 6a13bca2
# Usage
## Add as dependency in own project
This library can be used as maven dependency in an own project.
!!! attention
As it is not published to maven central,
but the GitLab integrated package registry,
you must configure an additional repository in your pom.
__repository config:__
```xml
<repository>
<id>unified-ticketing</id>
<url>https://transfer.hft-stuttgart.de/gitlab/api/v4/projects/154/packages/maven</url>
</repository>
```
__dependency information:__
```xml
<dependency>
<groupId>de.hftstuttgart</groupId>
<artifactId>unified-ticketing</artifactId>
<version>0.1.0</version>
</dependency>
```
??? tip "example how your pom should look like"
```xml
<project>
<!-- [...] -->
<dependencies>
<!-- [...] -->
<dependency>
<groupId>de.hftstuttgart</groupId>
<artifactId>unified-ticketing</artifactId>
<version>0.1.0</version>
</dependency>
</dependencies>
<!-- [...] -->
<repositories>
<!-- [...] -->
<repository>
<id>gitlab-maven</id>
<url>https://transfer.hft-stuttgart.de/gitlab/api/v4/projects/154/packages/maven</url>
</repository>
</repositories>
<!-- [...] -->
</project>
```
## Use in code
There are two central classes: `TicketSystem` and `Ticket`.
The majority of the library is written with the fluent-api design pattern.
To begin, you'll need an instance of `TicketSystem`.
This can be done, by calling the builder mechanism or pass a URI with all needed information.
Using this `TicketSystem` object you can search for tickets in the connected space,
change and save them or create new tickets.
To get full details of the available API, please switch to the [API docs](../api/index.md).
There you can find information and examples regarding the generic parts of the library,
as-well as system specific information, e.g. how an URI instantiation string has to look like, etc.
mkdocs.yml
View file @ 6a13bca2
site_name: Unified Ticketing Doku site_name: Unified Ticketing Docs
repo_name: 'Unified Ticketing Java Bibliothek'
repo_url: 'https://transfer.hft-stuttgart.de/gitlab/9Lukas5/unified-ticketing'
edit_uri: 'blob/master/docs/'
docs_dir: docs docs_dir: docs
edit_uri: 'blob/master/docs/'
repo_name: 'Code on Transfer Portal'
repo_url: 'https://transfer.hft-stuttgart.de/gitlab/9Lukas5/unified-ticketing'
copyright: 'Copyright &copy; 2020 Hochschule für Technik Stuttgart' copyright: 'Copyright &copy; 2020 University for Applied Sciences Stuttgart'
use_directory_urls: false use_directory_urls: false
nav: nav:
- Home: - Home:
- Index: 'index.md' - Index: 'index.md'
- Changelog: 'unified-ticketing/changelog-softlink.md'
- Usage: 'unified-ticketing/usage.md'
- Contributing: 'unified-ticketing/contributing.md'
- License: 'unified-ticketing/license-softlink.md'
- API:
- Index: 'api/index.md'
- Core:
- Logging: 'api/core/logging.md'
- Ticket: 'api/core/ticket.md'
- Ticketsystem: 'api/core/ticket-system.md'
- Exceptions: 'api/exceptions.md'
- Systems:
- GitLab:
- Ticket: 'api/systems/gitlab/ticket.md'
- Ticketsystem: 'api/systems/gitlab/ticket-system.md'
- Developers Guide:
- Machine Setup: 'developers-guide/machine-setup.md'
- Styleguide: 'developers-guide/styleguide.md'
- UML Diagram: 'developers-guide/uml.md'
- Workflow: 'developers-guide/workflow.md'
theme: theme:
features:
- navigation.tabs
icon:
logo: material/book-open
language: 'en'
name: 'material' name: 'material'
palette: palette:
primary: 'white' accent: 'blue'
accent: 'teal' primary: 'red'
language: 'en'
feature:
tabs: true
logo:
icon: library_books
markdown_extensions: markdown_extensions:
- admonition - admonition
- codehilite: - attr_list
linenums: true - footnotes
- toc: - markdown_del_ins
permalink: True - plantuml_markdown:
- footnotes format: svg
- tables server: http://plantuml.com/plantuml
- plantuml_markdown: - pymdownx.details
server: http://plantuml.com/plantuml - pymdownx.emoji:
format: svg emoji_index: !!python/name:materialx.emoji.twemoji
- pymdownx.emoji: emoji_generator: !!python/name:materialx.emoji.to_svg
emoji_generator: !!python/name:pymdownx.emoji.to_svg - pymdownx.highlight:
- pymdownx.tasklist linenums: true
- pymdownx.details - pymdownx.superfences
- pymdownx.superfences - pymdownx.tabbed
- pymdownx.tasklist
- toc:
permalink: True
- tables
pom.xml
View file @ 6a13bca2
...@@ -88,6 +88,22 @@ ...@@ -88,6 +88,22 @@
</dependency> </dependency>
</dependencies> </dependencies>
</plugin> </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<source>1.8</source>
<doclint>none</doclint>
</configuration>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins> </plugins>
</build> </build>
......

Dies ist die Gitlab-Instanz des Transferportals der Hochschule für Technik Stuttgart. Hier geht es zurück zum Portal