Skip to content

Commit

Permalink
Merge pull request #15415 from opf/documentation/markdown-lint
Browse files Browse the repository at this point in the history
documentation markdown lint
  • Loading branch information
as-op authored Apr 29, 2024
2 parents be6bfcd + ff479ec commit c337802
Show file tree
Hide file tree
Showing 470 changed files with 3,085 additions and 4,940 deletions.
3 changes: 0 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ The guides for [upgrading](./installation-and-operations/operation/upgrading) ar
* [Configure incoming mails](./installation-and-operations/configuration/incoming-emails)
* [Install custom plugins](./installation-and-operations/configuration/plugins)


## User Guides

Please see our [User Guide pages](./user-guide/) for detailed documentation on the functionality of OpenProject.
Expand All @@ -38,7 +37,6 @@ Please see our [User Guide pages](./user-guide/) for detailed documentation on t

Please see our [Use Cases section](./use-cases/) for detailed how-to guides and step-by-step instruction on how to set up a variety of common cases and views.


## Development

* [Full development environment for developers on Ubuntu](./development/development-environment-ubuntu) and [Mac OS X](./development/development-environment-osx)
Expand All @@ -48,7 +46,6 @@ Please see our [Use Cases section](./use-cases/) for detailed how-to guides and
* [Code review guidelines](./development/code-review-guidelines)
* [API documentation](./api)


## APIv3 documentation sources

The documentation for APIv3 is written in the [OpenAPI Format](https://www.openapis.org/) and its sources are being built from the entry point `openapi-spec.yml`.
2 changes: 1 addition & 1 deletion docs/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ We try to keep stable releases of OpenProject with changes to this API backwards

The API v3 is a general purpose API supporting multiple use cases.

While by no means complete, a whole lot of different scenarios can be automatized which otherwise would have to be carried out by hand via the UI.
While by no means complete, a whole lot of different scenarios can be automatized which otherwise would have to be carried out by hand via the UI.
Examples for this include managing work packages, projects and users.

[Go to OpenProject API](./introduction/)
Expand Down
2 changes: 1 addition & 1 deletion docs/api/apiv3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ retrieve the complete, singular file from any OpenProject server under `/api/v3/
Additionally, there is a script that outputs the specification as a whole as well, either as json or yaml depending on
the given format argument:

```
```shell
./script/api/spec --format yaml > openproject-oas.yml
```
1 change: 0 additions & 1 deletion docs/api/apiv3/client-libraries/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ While we cannot endorse or vet the libraries listed below we encourage their cre

If you need help developing a client library you can [contact us](mailto:[email protected]). If you want to have a client library listed in the list below you can again [contact us](mailto:[email protected]) or simply issue a PR with [changes to the source file](https://github.com/opf/openproject/blob/dev/docs/api/apiv3/client-libraries/README.md).


## JavaScript / TypeScript

* [op-client](https://www.npmjs.com/package/op-client): Client library for OpenProject server. Works both on Node.js and browser.
Expand Down
1 change: 0 additions & 1 deletion docs/api/apiv3/example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,6 @@ The value taken for the `href` in a resource value will always be the `self` lin

![work package create schema self link](./wp-create-form-schema-self-link.png)


*The correct combination of `project` and `type` needs to be chosen. Sometimes a type is not available in every project. In that case, the type either can be added to the project in the UI or a different type needs to be chosen for the project. This is why it sometimes makes sense to first send the project within the form body as this will update the `availableValues` listed for `type`*

### Sending the create request
Expand Down
Loading

0 comments on commit c337802

Please sign in to comment.