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
2 years ago · a0701032b6
parent 0674aa5aca
commit a0701032b6
413 changed files with 340 additions and 673 deletions
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@ -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.
--- a/docs/README.md
+++ b/docs/README.md
@ -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">
--- a/docs/api/README.md
+++ b/docs/api/README.md
@ -2,7 +2,6 @@
 sidebar_navigation:
  title: API documentation
  priority: 910
 robots: index, follow
 ---
 # OpenProject API
--- a/docs/api/faq/README.md
+++ b/docs/api/faq/README.md
@ -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 
 ---
--- a/docs/bim-guide/README.md
+++ b/docs/bim-guide/README.md
@ -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
--- a/docs/bim-guide/bim-issue-management/Cards-mode.png
+++ b/docs/bim-guide/bim-issue-management/Cards-mode.png
--- a/docs/bim-guide/bim-issue-management/Create-a-viewpoint.png
+++ b/docs/bim-guide/bim-issue-management/Create-a-viewpoint.png
--- a/docs/bim-guide/bim-issue-management/Filter-BIM-Issue.png
+++ b/docs/bim-guide/bim-issue-management/Filter-BIM-Issue.png
--- a/docs/bim-guide/bim-issue-management/OpenProject-toolbar.png
+++ b/docs/bim-guide/bim-issue-management/OpenProject-toolbar.png
--- a/docs/bim-guide/bim-issue-management/OpenProject_BCF_Module.png
+++ b/docs/bim-guide/bim-issue-management/OpenProject_BCF_Module.png
--- a/docs/bim-guide/bim-issue-management/README.md
+++ b/docs/bim-guide/bim-issue-management/README.md
@ -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
 ---
--- a/docs/bim-guide/bim-issue-management/Viewer_and_Cards.png
+++ b/docs/bim-guide/bim-issue-management/Viewer_and_Cards.png
--- a/docs/bim-guide/bim-issue-management/adding-multiple-viewpoints.png
+++ b/docs/bim-guide/bim-issue-management/adding-multiple-viewpoints.png
--- a/docs/bim-guide/bim-issue-management/bcf_module.png
+++ b/docs/bim-guide/bim-issue-management/bcf_module.png
--- a/docs/bim-guide/bim-issue-management/bim-issues-and-work-packages.png
+++ b/docs/bim-guide/bim-issue-management/bim-issues-and-work-packages.png
--- a/docs/bim-guide/bim-issue-management/create-a-new-BIM-issue.png
+++ b/docs/bim-guide/bim-issue-management/create-a-new-BIM-issue.png
--- a/docs/bim-guide/bim-issue-management/display_bim_issue.png
+++ b/docs/bim-guide/bim-issue-management/display_bim_issue.png
--- a/docs/bim-guide/bim-issue-management/import-bcf.png
+++ b/docs/bim-guide/bim-issue-management/import-bcf.png
--- a/docs/bim-guide/bim-issue-management/imported-bcf-issues.png
+++ b/docs/bim-guide/bim-issue-management/imported-bcf-issues.png
--- a/docs/bim-guide/bim-issue-management/model_maps_view.png
+++ b/docs/bim-guide/bim-issue-management/model_maps_view.png
--- a/docs/bim-guide/bim-issue-management/outdated-bcf-issues.png
+++ b/docs/bim-guide/bim-issue-management/outdated-bcf-issues.png
--- a/docs/bim-guide/bim-issue-management/successfull-bcf-import.png
+++ b/docs/bim-guide/bim-issue-management/successfull-bcf-import.png
--- a/docs/bim-guide/bim-issue-management/table.png
+++ b/docs/bim-guide/bim-issue-management/table.png
--- a/docs/bim-guide/bim-issue-management/viewer-and-table.png
+++ b/docs/bim-guide/bim-issue-management/viewer-and-table.png
--- a/docs/bim-guide/ifc-viewer/2-d-view.png
+++ b/docs/bim-guide/ifc-viewer/2-d-view.png
--- a/docs/bim-guide/ifc-viewer/README.md
+++ b/docs/bim-guide/ifc-viewer/README.md
@ -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
 ---
--- a/docs/bim-guide/ifc-viewer/Select_elements.png
+++ b/docs/bim-guide/ifc-viewer/Select_elements.png
--- a/docs/bim-guide/ifc-viewer/Show_Hide_Elements.gif
+++ b/docs/bim-guide/ifc-viewer/Show_Hide_Elements.gif
--- a/docs/bim-guide/ifc-viewer/Upload_IFC_Model.png
+++ b/docs/bim-guide/ifc-viewer/Upload_IFC_Model.png
--- a/docs/bim-guide/ifc-viewer/add-a-new-ifc-model.png
+++ b/docs/bim-guide/ifc-viewer/add-a-new-ifc-model.png
--- a/docs/bim-guide/ifc-viewer/bim-model-management.png
+++ b/docs/bim-guide/ifc-viewer/bim-model-management.png
--- a/docs/bim-guide/ifc-viewer/clear_slices.png
+++ b/docs/bim-guide/ifc-viewer/clear_slices.png
--- a/docs/bim-guide/ifc-viewer/element-properties.png
+++ b/docs/bim-guide/ifc-viewer/element-properties.png
--- a/docs/bim-guide/ifc-viewer/first-person-button.png
+++ b/docs/bim-guide/ifc-viewer/first-person-button.png
--- a/docs/bim-guide/ifc-viewer/fit-view-button.png
+++ b/docs/bim-guide/ifc-viewer/fit-view-button.png
--- a/docs/bim-guide/ifc-viewer/hide-elements-button.png
+++ b/docs/bim-guide/ifc-viewer/hide-elements-button.png
--- a/docs/bim-guide/ifc-viewer/hide-elements-context-menu.png
+++ b/docs/bim-guide/ifc-viewer/hide-elements-context-menu.png
--- a/docs/bim-guide/ifc-viewer/ifc-viewer-overview.png
+++ b/docs/bim-guide/ifc-viewer/ifc-viewer-overview.png
--- a/docs/bim-guide/ifc-viewer/import-and-export-ifc-models.png
+++ b/docs/bim-guide/ifc-viewer/import-and-export-ifc-models.png
--- a/docs/bim-guide/ifc-viewer/import-ifc-model.png
+++ b/docs/bim-guide/ifc-viewer/import-ifc-model.png
--- a/docs/bim-guide/ifc-viewer/inspect-properties.png
+++ b/docs/bim-guide/ifc-viewer/inspect-properties.png
--- a/docs/bim-guide/ifc-viewer/orthographic-button.png
+++ b/docs/bim-guide/ifc-viewer/orthographic-button.png
--- a/docs/bim-guide/ifc-viewer/orthographic-view.png
+++ b/docs/bim-guide/ifc-viewer/orthographic-view.png
--- a/docs/bim-guide/ifc-viewer/reset-view.png
+++ b/docs/bim-guide/ifc-viewer/reset-view.png
--- a/docs/bim-guide/ifc-viewer/select-elements-button.png
+++ b/docs/bim-guide/ifc-viewer/select-elements-button.png
--- a/docs/bim-guide/ifc-viewer/set-model-as-default.png
+++ b/docs/bim-guide/ifc-viewer/set-model-as-default.png
--- a/docs/bim-guide/ifc-viewer/show-in-explorer.png
+++ b/docs/bim-guide/ifc-viewer/show-in-explorer.png
--- a/docs/bim-guide/ifc-viewer/show-properties-button.png
+++ b/docs/bim-guide/ifc-viewer/show-properties-button.png
--- a/docs/bim-guide/ifc-viewer/show-properties.png
+++ b/docs/bim-guide/ifc-viewer/show-properties.png
--- a/docs/bim-guide/ifc-viewer/slice-building-model.png
+++ b/docs/bim-guide/ifc-viewer/slice-building-model.png
--- a/docs/bim-guide/revit-add-in/OpenProject_BIM_Add_Viewpoint.png
+++ b/docs/bim-guide/revit-add-in/OpenProject_BIM_Add_Viewpoint.png
--- a/docs/bim-guide/revit-add-in/OpenProject_BIM_BCF_Module.png
+++ b/docs/bim-guide/revit-add-in/OpenProject_BIM_BCF_Module.png
--- a/docs/bim-guide/revit-add-in/OpenProject_BIM_Create_BCF.png
+++ b/docs/bim-guide/revit-add-in/OpenProject_BIM_Create_BCF.png
--- a/docs/bim-guide/revit-add-in/OpenProject_BIM_Issues.png
+++ b/docs/bim-guide/revit-add-in/OpenProject_BIM_Issues.png
--- a/docs/bim-guide/revit-add-in/OpenProject_BIM_Login.png
+++ b/docs/bim-guide/revit-add-in/OpenProject_BIM_Login.png
--- a/docs/bim-guide/revit-add-in/OpenProject_BIM_Projects.png
+++ b/docs/bim-guide/revit-add-in/OpenProject_BIM_Projects.png
--- a/docs/bim-guide/revit-add-in/OpenProject_BIM_Start.png
+++ b/docs/bim-guide/revit-add-in/OpenProject_BIM_Start.png
--- a/docs/bim-guide/revit-add-in/OpenProject_BIM_Synchronization.png
+++ b/docs/bim-guide/revit-add-in/OpenProject_BIM_Synchronization.png
--- a/docs/bim-guide/revit-add-in/README.md
+++ b/docs/bim-guide/revit-add-in/README.md
@ -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
 ---
--- a/docs/bim-guide/revit-add-in/RevitAddIn_Settings.png
+++ b/docs/bim-guide/revit-add-in/RevitAddIn_Settings.png
--- a/docs/bim-guide/revit-add-in/installation-step-01.png
+++ b/docs/bim-guide/revit-add-in/installation-step-01.png
--- a/docs/bim-guide/revit-add-in/installation-step-02.png
+++ b/docs/bim-guide/revit-add-in/installation-step-02.png
--- a/docs/bim-guide/revit-add-in/installation-step-03.png
+++ b/docs/bim-guide/revit-add-in/installation-step-03.png
--- a/docs/bim-guide/revit-add-in/installer-smart-screen-01.png
+++ b/docs/bim-guide/revit-add-in/installer-smart-screen-01.png
--- a/docs/bim-guide/revit-add-in/installer-smart-screen-02.png
+++ b/docs/bim-guide/revit-add-in/installer-smart-screen-02.png
--- a/docs/development/README.md
+++ b/docs/development/README.md
@ -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
--- a/docs/development/concepts/README.md
+++ b/docs/development/concepts/README.md
@ -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
 ---
--- a/docs/development/concepts/application-architecture/README.md
+++ b/docs/development/concepts/application-architecture/README.md
@ -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
 ---
--- a/docs/development/concepts/dynamic-forms/README.md
+++ b/docs/development/concepts/dynamic-forms/README.md
@ -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
 ---
--- a/docs/development/concepts/hal-resources/README.md
+++ b/docs/development/concepts/hal-resources/README.md
@ -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
 ---
--- a/docs/development/concepts/infrastructure/README.md
+++ b/docs/development/concepts/infrastructure/README.md
@ -2,7 +2,6 @@
 sidebar_navigation:
  title: Infrastructure overview
 description: An introduction of the infrastructure architecture used at OpenProject.
 robots: index, follow
 keywords: infrastructure
 ---
--- a/docs/development/concepts/inline-editing/README.md
+++ b/docs/development/concepts/inline-editing/README.md
@ -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
 ---
--- a/docs/development/concepts/permissions/README.md
+++ b/docs/development/concepts/permissions/README.md
@ -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
 ---
--- a/docs/development/concepts/queries/README.md
+++ b/docs/development/concepts/queries/README.md
@ -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
 ---
--- a/docs/development/concepts/resource-changesets/README.md
+++ b/docs/development/concepts/resource-changesets/README.md
@ -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
 ---
--- a/docs/development/concepts/resource-schemas/README.md
+++ b/docs/development/concepts/resource-schemas/README.md
@ -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
 ---
--- a/docs/development/concepts/state-management/README.md
+++ b/docs/development/concepts/state-management/README.md
@ -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
 ---
--- a/docs/development/concepts/translations/README.md
+++ b/docs/development/concepts/translations/README.md
@ -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
 ---
--- a/docs/development/contribution-documentation/README.md
+++ b/docs/development/contribution-documentation/README.md
@ -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
 ---
--- a/docs/development/contribution-documentation/contribution-support/README.md
+++ b/docs/development/contribution-documentation/contribution-support/README.md
@ -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
 ---
--- a/docs/development/contribution-documentation/documentation-process-internal-contributor/README.md
+++ b/docs/development/contribution-documentation/documentation-process-internal-contributor/README.md
@ -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
 ---
--- a/docs/development/contribution-documentation/documentation-process-internal-contributor/create-new-branch-step-2.png
+++ b/docs/development/contribution-documentation/documentation-process-internal-contributor/create-new-branch-step-2.png
--- a/docs/development/contribution-documentation/documentation-process-internal-contributor/create-pull-request-github-desktop.png
+++ b/docs/development/contribution-documentation/documentation-process-internal-contributor/create-pull-request-github-desktop.png
--- a/docs/development/contribution-documentation/documentation-process-internal-contributor/fetch-origin-in-github-desktop.png
+++ b/docs/development/contribution-documentation/documentation-process-internal-contributor/fetch-origin-in-github-desktop.png
--- a/docs/development/contribution-documentation/documentation-process-internal-contributor/select-cloned-repository.png
+++ b/docs/development/contribution-documentation/documentation-process-internal-contributor/select-cloned-repository.png
--- a/docs/development/contribution-documentation/documentation-process/README.md
+++ b/docs/development/contribution-documentation/documentation-process/README.md
@ -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
 ---
--- a/docs/development/contribution-documentation/documentation-process/create-pull-request-github-desktop.png
+++ b/docs/development/contribution-documentation/documentation-process/create-pull-request-github-desktop.png
--- a/docs/development/contribution-documentation/documentation-process/create-pull-request.png
+++ b/docs/development/contribution-documentation/documentation-process/create-pull-request.png
--- a/docs/development/contribution-documentation/documentation-process/fetch-upstream-changes.png
+++ b/docs/development/contribution-documentation/documentation-process/fetch-upstream-changes.png
--- a/docs/development/contribution-documentation/documentation-style-guide/README.md
+++ b/docs/development/contribution-documentation/documentation-style-guide/README.md
@ -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
 ---
--- a/docs/development/design-system/README.md
+++ b/docs/development/design-system/README.md
@ -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
--- a/docs/development/faq/README.md
+++ b/docs/development/faq/README.md
@ -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
--- a/docs/development/first-look/README.md
+++ b/docs/development/first-look/README.md
@ -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
--- a/docs/development/git-workflow/README.md
+++ b/docs/development/git-workflow/README.md
@ -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
 ---
--- a/docs/development/product-development-handbook/README.md
+++ b/docs/development/product-development-handbook/README.md
@ -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
 ---
--- a/docs/development/profiling/flamegraph_retrieval.png
+++ b/docs/development/profiling/flamegraph_retrieval.png
--- a/docs/development/report-a-bug/README.md
+++ b/docs/development/report-a-bug/README.md
@ -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
--- a/docs/development/saml/README.md
+++ b/docs/development/saml/README.md
@ -2,7 +2,6 @@
 sidebar_navigation:
  title: SAML development setup
  priority: 920
 robots: index, follow
 ---
 # Set up a development SAML idP
--- a/docs/development/submit-feature-idea/README.md
+++ b/docs/development/submit-feature-idea/README.md
@ -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
--- a/docs/development/translate-openproject/README.md
+++ b/docs/development/translate-openproject/README.md
@ -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
 ---
--- a/Show More
+++ b/Show More