Fix/docs (#10869) [skip ci]

* fix(docs): remove unused images
* fix(docs): reduce png image sizes
* fix(docs): invalid signs in markdown formatting
* fix(docs): adjust legal link
* fix(docs): don't use ZWSP & NBSP without reason
* fix(docs): cleanup release notes index page
* fix(docs): remove unused markdown frontmatter
This commit is contained in:
Andrej Sandorf
2022-06-28 10:55:12 +02:00
committed by GitHub
parent 0674aa5aca
commit a0701032b6
413 changed files with 340 additions and 673 deletions
+1 -1
View File
@@ -143,5 +143,5 @@ version 1.0.0, available at
## Contributors license agreement
Contributors have to sign a CLA before contributing to OpenProject.
The [CLA can be found here](https://www.openproject.org/contributor-license-agreement/)
The [CLA can be found here](https://www.openproject.org/legal/contributor-license-agreement/)
and has to be filled out and sent to info@openproject.org.
+1 -2
View File
@@ -3,9 +3,8 @@ sidebar_navigation:
title: OpenProject Documentation
priority: 999
description: Help and documentation for OpenProject Community Edition, Enterprise on-premises and Enterprise cloud.
robots: index, follow
keywords: help, documentation
---
---
# OpenProject Documentation
<div class="alert alert-info" role="alert">
-1
View File
@@ -2,7 +2,6 @@
sidebar_navigation:
title: API documentation
priority: 910
robots: index, follow
---
# OpenProject API
-1
View File
@@ -3,7 +3,6 @@ sidebar_navigation:
title: FAQ
priority: 001
description: Frequently asked questions regarding the API of OpenProject
robots: index, follow
keywords: API FAQ, API v3, RestAPI, interface, connector
---
-1
View File
@@ -3,7 +3,6 @@ sidebar_navigation:
title: BIM guide
priority: 975
description: User guide for the OpenProject BIM Edition.
robots: index, follow
keywords: BIM user guide
---
# BIM guide
Binary file not shown.

Before

Width:  |  Height:  |  Size: 189 KiB

After

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 310 KiB

After

Width:  |  Height:  |  Size: 99 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 372 KiB

After

Width:  |  Height:  |  Size: 120 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 5.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 9.0 KiB

@@ -3,7 +3,6 @@ sidebar_navigation:
title: BIM issue management
priority: 200
description: How to use OpenProject BIM Issue Management.
robots: index, follow
keywords: BIM, BCF, IFC, BIM Issue Management, BCF-Management
---
Binary file not shown.

Before

Width:  |  Height:  |  Size: 435 KiB

After

Width:  |  Height:  |  Size: 128 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 312 KiB

After

Width:  |  Height:  |  Size: 120 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 381 KiB

After

Width:  |  Height:  |  Size: 116 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 111 KiB

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 486 KiB

After

Width:  |  Height:  |  Size: 148 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 158 KiB

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 610 KiB

After

Width:  |  Height:  |  Size: 200 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 381 KiB

After

Width:  |  Height:  |  Size: 115 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 64 KiB

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 92 KiB

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 82 KiB

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 349 KiB

After

Width:  |  Height:  |  Size: 126 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.2 KiB

After

Width:  |  Height:  |  Size: 4.3 KiB

-1
View File
@@ -3,7 +3,6 @@ sidebar_navigation:
title: IFC viewer
priority: 300
description: How to use the OpenProject IFC-Viewer.
robots: index, follow
keywords: BIM, BCF, IFC, Viewer
---
Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.5 MiB

After

Width:  |  Height:  |  Size: 810 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 370 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.2 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 351 KiB

After

Width:  |  Height:  |  Size: 107 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 449 KiB

After

Width:  |  Height:  |  Size: 125 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 350 KiB

After

Width:  |  Height:  |  Size: 105 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 259 KiB

After

Width:  |  Height:  |  Size: 86 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.2 KiB

After

Width:  |  Height:  |  Size: 4.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.2 KiB

After

Width:  |  Height:  |  Size: 4.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.2 KiB

After

Width:  |  Height:  |  Size: 4.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 383 KiB

After

Width:  |  Height:  |  Size: 106 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 358 KiB

After

Width:  |  Height:  |  Size: 110 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 457 KiB

After

Width:  |  Height:  |  Size: 124 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 432 KiB

After

Width:  |  Height:  |  Size: 119 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 276 KiB

After

Width:  |  Height:  |  Size: 92 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.2 KiB

After

Width:  |  Height:  |  Size: 4.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 418 KiB

After

Width:  |  Height:  |  Size: 128 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.1 KiB

After

Width:  |  Height:  |  Size: 4.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.2 KiB

After

Width:  |  Height:  |  Size: 4.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 775 KiB

After

Width:  |  Height:  |  Size: 231 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 320 KiB

After

Width:  |  Height:  |  Size: 92 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.2 KiB

After

Width:  |  Height:  |  Size: 4.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 269 KiB

After

Width:  |  Height:  |  Size: 88 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.2 KiB

After

Width:  |  Height:  |  Size: 4.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 453 KiB

After

Width:  |  Height:  |  Size: 155 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 425 KiB

After

Width:  |  Height:  |  Size: 143 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 420 KiB

After

Width:  |  Height:  |  Size: 145 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 439 KiB

After

Width:  |  Height:  |  Size: 150 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 360 KiB

After

Width:  |  Height:  |  Size: 118 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 447 KiB

After

Width:  |  Height:  |  Size: 154 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 407 KiB

After

Width:  |  Height:  |  Size: 140 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 332 KiB

After

Width:  |  Height:  |  Size: 103 KiB

-1
View File
@@ -3,7 +3,6 @@ sidebar_navigation:
title: Revit add-in
priority: 100
description: How to use the OpenProject BIM - Revit add-in.
robots: index, follow
keywords: BIM, BCF, IFC, Viewer
---
Binary file not shown.

Before

Width:  |  Height:  |  Size: 407 KiB

After

Width:  |  Height:  |  Size: 140 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 35 KiB

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 30 KiB

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 25 KiB

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 16 KiB

+1 -2
View File
@@ -2,7 +2,6 @@
sidebar_navigation:
title: Development
priority: 920
robots: index, follow
---
# Develop OpenProject
@@ -95,7 +94,7 @@ This code of conduct is adapted from the [Contributor Covenant](https://www.cont
If you want to contribute to OpenProject, please make sure to accept our Contributor License Agreement first. The contributor license agreement documents the rights granted by contributors to OpenProject.
[Read and accept the Contributor License Agreement here.](https://www.openproject.org/contributor-license-agreement/)
[Read and accept the Contributor License Agreement here.](https://www.openproject.org/legal/contributor-license-agreement/)
# Additional resources
-1
View File
@@ -2,7 +2,6 @@
sidebar_navigation:
title: Development concepts
description: Get an overview of the development process and concepts at OpenProject
robots: index, follow
keywords: development concepts, big picture
---
@@ -2,7 +2,6 @@
sidebar_navigation:
title: Application architecture
description: An introduction of the architecture used at OpenProject and their interplay.
robots: index, follow
keywords: architecture overview, hybrid application, Ruby on Rails, Angular
---
@@ -2,7 +2,6 @@
sidebar_navigation:
title: Dynamically generated forms
description: An introduction on how to generate forms from an API form object
robots: index, follow
keywords: concept, forms, dynamic forms, schemas
---
@@ -2,7 +2,6 @@
sidebar_navigation:
title: HAL+JSON resources
description: Get an overview of how inline-editing of resources works
robots: index, follow
keywords: development concepts, HAL, JSON, hal resources, API requests
---
@@ -2,7 +2,6 @@
sidebar_navigation:
title: Infrastructure overview
description: An introduction of the infrastructure architecture used at OpenProject.
robots: index, follow
keywords: infrastructure
---
@@ -2,7 +2,6 @@
sidebar_navigation:
title: Inline editing
description: Get an overview of how inline-editing of resources works
robots: index, follow
keywords: development concepts, inline editing, edit forms
---
@@ -2,7 +2,6 @@
sidebar_navigation:
title: Permissions
description: Get an overview of how roles and permissions are handled in the OpenProject application code
robots: index, follow
keywords: permissions, roles, RBAC
---
@@ -2,7 +2,6 @@
sidebar_navigation:
title: Queries
description: An introduction to queries in OpenProject and their use in the frontend
robots: index, follow
keywords: queries, query space, work package views
---
@@ -2,7 +2,6 @@
sidebar_navigation:
title: Resource changesets
description: Get an overview of how frontend changesets work when editing hal resources
robots: index, follow
keywords: changesets, editing, HAL resources
---
@@ -2,7 +2,6 @@
sidebar_navigation:
title: Schemas
description: An introduction to resource schemas and how they are tied to editable resources
robots: index, follow
keywords: concept, schemas, resource schemas
---
@@ -2,7 +2,6 @@
sidebar_navigation:
title: State management
description: Get an overview of how frontend state management works
robots: index, follow
keywords: state management, stores, input states
---
@@ -2,7 +2,6 @@
sidebar_navigation:
title: Translations
description: Get an overview of how translations are being used in OpenProject, and how they end up in the frontend
robots: index, follow
keywords: translations, I18n, localization, locales, languages
---
@@ -3,7 +3,6 @@ sidebar_navigation:
title: Contribute to documentation
priority: 999
description: Overview of the OpenProject documentation
robots: index, follow
keywords: contribution, documentation, documentation process
---
@@ -3,7 +3,6 @@ sidebar_navigation:
title: Support for contribution
priority: 600
description: What to do if you need help or support for your contribution
robots: index, follow
keywords: help, support, documentation process, documentation
---
@@ -3,7 +3,6 @@ sidebar_navigation:
title: Internal docs contributor
priority: 800
description: Quick guide for internal team members that have write permissions
robots: index, follow
keywords: contribution, documentation, documentation process
---
Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 9.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 35 KiB

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.4 KiB

After

Width:  |  Height:  |  Size: 3.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 9.3 KiB

@@ -3,7 +3,6 @@ sidebar_navigation:
title: Documentation process
priority: 999
description: The process, incl. tool setup, of how to contribute to the OpenProject documentation
robots: index, follow
keywords: contribution, documentation, documentation process, tool setup
---
Binary file not shown.

Before

Width:  |  Height:  |  Size: 35 KiB

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 124 KiB

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 69 KiB

After

Width:  |  Height:  |  Size: 23 KiB

@@ -3,7 +3,6 @@ sidebar_navigation:
title: Documentation style guide
priority: 700
description: What styles and formats to follow when contributing to the OpenProject documentation
robots: index, follow
keywords: documentation style guide, style guide, format, style
---
-1
View File
@@ -3,7 +3,6 @@ sidebar_navigation:
title: Design system
priority: 998
description: OpenProject Design System
robots: index, follow
keywords: Design system, styles, design, components
---
# Design System
-1
View File
@@ -3,7 +3,6 @@ sidebar_navigation:
title: Development FAQ
priority: 980
description: Frequently asked questions for development
robots: index, follow
keywords: FAQ, change code, developing, plug-in
---
# Frequently asked questions (FAQ) for development
-1
View File
@@ -3,7 +3,6 @@ sidebar_navigation:
title: OpenProject First Look
priority: 1
description: Beta testing OpenProject
robots: index, follow
keywords: first look, beta testing
---
# OpenProject First Look
-1
View File
@@ -2,7 +2,6 @@
sidebar_navigation:
title: Development workflow
description: How new features and bug fixes are developed at OpenProject
robots: index, follow
keywords: development workflow, gitflow, git flow
---
@@ -3,7 +3,6 @@ sidebar_navigation:
title: Product development
priority: 999
description: Learn about OpenProject's product development process and the RICE score
robots: index, follow
keywords: product development, requirement process, RICE score
---
Binary file not shown.

Before

Width:  |  Height:  |  Size: 86 KiB

After

Width:  |  Height:  |  Size: 30 KiB

-1
View File
@@ -3,7 +3,6 @@ sidebar_navigation:
title: Report a bug
priority: 995
description: How to submit a bug report for OpenProject
robots: index, follow
keywords: bug report, bug, error, not working
---
# Report a bug
-1
View File
@@ -2,7 +2,6 @@
sidebar_navigation:
title: SAML development setup
priority: 920
robots: index, follow
---
# Set up a development SAML idP
@@ -3,7 +3,6 @@ sidebar_navigation:
title: Submit a feature idea
priority: 990
description: How to submit an idea for a feature for OpenProject
robots: index, follow
keywords: feature requests, ideas, open feature request
---
# Submit a feature idea
@@ -3,7 +3,6 @@ sidebar_navigation:
title: Translate OpenProject
priority: 985
description: How to translate OpenProject to your language
robots: index, follow
keywords: translation, translate, crowdin, localization
---

Some files were not shown because too many files have changed in this diff Show More