From 19d66fff0db3fa05ee6edc2230e81a7d7d49379e Mon Sep 17 00:00:00 2001 From: as-op Date: Wed, 20 Mar 2024 10:05:28 +0100 Subject: [PATCH] fix(docs): spelling and typos --- README.md | 2 +- docs/bim-guide/revit-add-in/README.md | 2 +- .../documentation-process/README.md | 4 ++-- .../development-environment-docker/README.md | 2 +- docs/development/running-tests/README.md | 2 +- docs/glossary/README.md | 2 +- .../configuration/README.md | 2 +- .../configuration/plugins/README.md | 2 +- docs/release-notes/11/11-0-0/README.md | 4 ++-- docs/release-notes/11/11-3-0/README.md | 4 ++-- docs/release-notes/11/11-4-0/README.md | 2 +- docs/release-notes/12/12-1-0/README.md | 2 +- docs/release-notes/13-3-0/README.md | 2 +- docs/release-notes/13-4-0/README.md | 6 +++--- docs/release-notes/3/3-0-16/README.md | 2 +- docs/release-notes/4/4-0-2/README.md | 2 +- docs/release-notes/8/8-0-2/README.md | 2 +- .../processing-of-personal-data/README.md | 4 ++-- .../system-admin-guide/file-storages/README.md | 2 +- docs/system-admin-guide/integrations/README.md | 2 +- .../integrations/github-integration/README.md | 2 +- .../integrations/gitlab-integration/README.md | 4 ++-- docs/user-guide/file-management/README.md | 2 +- .../one-drive-integration/README.md | 8 ++++---- modules/gitlab_integration/README.md | 18 +++++++++--------- 25 files changed, 43 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index cdb6ab166a74..4089849e7cb7 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ![GitHub release (latest by date)](https://img.shields.io/github/v/release/opf/openproject) ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/opf/openproject) ![GitHub branch checks state](https://img.shields.io/github/checks-status/opf/openproject/dev) -[![Github Tests](https://github.com/opf/openproject/actions/workflows/test-core.yml/badge.svg?branch=dev)](https://github.com/opf/openproject/actions/workflows/test-core.yml) +[![GitHub Tests](https://github.com/opf/openproject/actions/workflows/test-core.yml/badge.svg?branch=dev)](https://github.com/opf/openproject/actions/workflows/test-core.yml) OpenProject is a web-based project management software. Its key features are: diff --git a/docs/bim-guide/revit-add-in/README.md b/docs/bim-guide/revit-add-in/README.md index 435b81ebd668..94dada52c25d 100644 --- a/docs/bim-guide/revit-add-in/README.md +++ b/docs/bim-guide/revit-add-in/README.md @@ -48,7 +48,7 @@ The **OpenProject Revit AddIn** does not have any special system requirements. A To download the setup application for the **OpenProject Revit AddIn**, click here: [DOWNLOAD](https://github.com/opf/openproject-revit-add-in/releases/download/v2.3.3/OpenProject.Revit.exe) -You can find the latest version of our AddIn on [Github](https://github.com/opf/openproject-revit-add-in/releases/latest) as well. +You can find the latest version of our AddIn on [GitHub](https://github.com/opf/openproject-revit-add-in/releases/latest) as well. diff --git a/docs/development/contribution-documentation/documentation-process/README.md b/docs/development/contribution-documentation/documentation-process/README.md index 1962c6a0c252..fb9b76e126af 100644 --- a/docs/development/contribution-documentation/documentation-process/README.md +++ b/docs/development/contribution-documentation/documentation-process/README.md @@ -32,7 +32,7 @@ You can download the installer from the [Typora website](https://typora.io). Fol You can install the software GitHub Desktop on any [supported operating systems](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/overview/supported-operating-systems). To install GitHub Desktop navigate to [https://desktop.github.com](https://desktop.github.com) and download the appropriate version for your operating system. Follow the prompts to complete the installation. -## Step 4: Sign in into Github.com in GitHub Desktop +## Step 4: Sign in into GitHub.com in GitHub Desktop To exchange data between your local repository and remote repositories you need to first sign (File -> Options -> Sign in). @@ -196,7 +196,7 @@ In GitHub Desktop **at Current branch the old branch is visible [1]** . After yo #### C) Change remote repository back to the forked repository (ORIGIN) -In Github Desktop choose menu "Repository -> Repository settings". This will open a new window (screenshot below). Enter the URL of your forked OpenProject repository (e.g. https://github.com/adam-op/openproject.git). Confirm with **Save** +In GitHub Desktop choose menu "Repository -> Repository settings". This will open a new window (screenshot below). Enter the URL of your forked OpenProject repository (e.g. https://github.com/adam-op/openproject.git). Confirm with **Save** ![rebase-your-fork-step-3](rebase-your-fork-step-3.png) diff --git a/docs/development/development-environment-docker/README.md b/docs/development/development-environment-docker/README.md index ffa759efbe7a..191755e3dcf2 100644 --- a/docs/development/development-environment-docker/README.md +++ b/docs/development/development-environment-docker/README.md @@ -396,7 +396,7 @@ docker compose --project-directory docker/dev/tls up -d ## GitLab CE Service -Within `docker/dev/gitlab` a compose file is provided for running local Gitlab instance with TLS support. This provides +Within `docker/dev/gitlab` a compose file is provided for running local GitLab instance with TLS support. This provides a production like environment for testing the OpenProject GitLab integration against a community edition GitLab instance accessible on `https://gitlab.local`. diff --git a/docs/development/running-tests/README.md b/docs/development/running-tests/README.md index 0eebfa67defc..79e39b8fc71a 100644 --- a/docs/development/running-tests/README.md +++ b/docs/development/running-tests/README.md @@ -837,7 +837,7 @@ OPENPROJECT_CLI_PROXY='http://:4200' ./bin/rails s -b 0.0.0.0 -p # Now access your server from http://:3000 with code reloading ``` -You might have to also update your host name setting `bundle exec rake setting:set[host_name=yourip]`. +You might have to also update your host name setting `bundle exec rake setting:set[host_name=your-ip]`. ## Legacy LDAP tests diff --git a/docs/glossary/README.md b/docs/glossary/README.md index bd18d288858d..3c3bd4d27dbf 100644 --- a/docs/glossary/README.md +++ b/docs/glossary/README.md @@ -274,7 +274,7 @@ Your activated plugins are listed together with your [modules](#module) in your ### Primer design system -OpenProject started adopting [Github's Primer Design System](https://primer.style/) in 2023. New features will be developed using Primer and existing features will will be gradually revised. Relevant reusable components from Primer as well as common patterns and compositions of these components will be documented in our [Lookbook](https://qa.openproject-edge.com/lookbook/pages/how_to_use). [Read more about OpenProject's decision to use Primer](https://www.openproject.org/blog/primer-design-system/). +OpenProject started adopting [GitHub's Primer Design System](https://primer.style/) in 2023. New features will be developed using Primer and existing features will will be gradually revised. Relevant reusable components from Primer as well as common patterns and compositions of these components will be documented in our [Lookbook](https://qa.openproject-edge.com/lookbook/pages/how_to_use). [Read more about OpenProject's decision to use Primer](https://www.openproject.org/blog/primer-design-system/). ### Project diff --git a/docs/installation-and-operations/configuration/README.md b/docs/installation-and-operations/configuration/README.md index 92e9234ecf47..3571d5935f80 100644 --- a/docs/installation-and-operations/configuration/README.md +++ b/docs/installation-and-operations/configuration/README.md @@ -758,7 +758,7 @@ OPENPROJECT_2FA_ENFORCED="true" **Setting available strategies** -By default, the TOTP and WebAuthn strategie are active. +By default, the TOTP and WebAuthn strategies are active. If you have a [MessageBird account](https://www.messagebird.com/), you can setup a SMS 2FA by activating that strategy like so: diff --git a/docs/installation-and-operations/configuration/plugins/README.md b/docs/installation-and-operations/configuration/plugins/README.md index 99faac1d6a5d..7282137ec9f7 100644 --- a/docs/installation-and-operations/configuration/plugins/README.md +++ b/docs/installation-and-operations/configuration/plugins/README.md @@ -24,7 +24,7 @@ group :opf_plugins do end ``` -**Note:** The Gitlab plugin is usually only compatible with the latest versions. For more information, please see the respective repository: https://github.com/btey/openproject-gitlab-integration/ +**Note:** The GitLab plugin is usually only compatible with the latest versions. For more information, please see the respective repository: https://github.com/btey/openproject-gitlab-integration/ The group `:opf_plugins` is generally recommended, but only required for plugins with custom frontend code that is picked up by webpack and output into their respective bundles. diff --git a/docs/release-notes/11/11-0-0/README.md b/docs/release-notes/11/11-0-0/README.md index e3f569d5990b..1bfaa6c36e6c 100644 --- a/docs/release-notes/11/11-0-0/README.md +++ b/docs/release-notes/11/11-0-0/README.md @@ -229,7 +229,7 @@ There are lots and lots of new things we packed into 11.0 to tell you about. - Fixed: Error 500 when bulk-editing work packages \[[#34588](https://community.openproject.org/wp/34588)\] - Fixed: Year almost hidden in date picker for version \[[#34590](https://community.openproject.org/wp/34590)\] - Fixed: Onboarding tour broken in multiple places \[[#34597](https://community.openproject.org/wp/34597)\] -- Fixed: Github Integration \[[#34598](https://community.openproject.org/wp/34598)\] +- Fixed: GitHub Integration \[[#34598](https://community.openproject.org/wp/34598)\] - Fixed: Google OpenID provider image not shown in login form \[[#34601](https://community.openproject.org/wp/34601)\] - Fixed: Parent work package in manual scheduling mode without date cannot be scheduled from Gantt chart \[[#34710](https://community.openproject.org/wp/34710)\] - Fixed: Menu too small/completely hidden on Roadmap \[[#34712](https://community.openproject.org/wp/34712)\] @@ -291,7 +291,7 @@ There are lots and lots of new things we packed into 11.0 to tell you about. - Changed: Improve board creation modal \[[#34070](https://community.openproject.org/wp/34070)\] - Changed: Hide derived (Start/Finish) Date from work package forms \[[#34122](https://community.openproject.org/wp/34122)\] - Changed: Extend search autocompleter with useful information \[[#34132](https://community.openproject.org/wp/34132)\] -- Changed: [all projects overview] (Add option to) show status-text in expanded view. \[[#34191](https://community.openproject.org/wp/34191)\] +- Changed: \[all projects overview\] (Add option to) show status-text in expanded view. \[[#34191](https://community.openproject.org/wp/34191)\] - Changed: Map board subtasks columns when copying projects \[[#34238](https://community.openproject.org/wp/34238)\] - Changed: Having meetings as a linkable resource \[[#34256](https://community.openproject.org/wp/34256)\] - Changed: What's new teaser OpenProject BIM 11.0 \[[#34514](https://community.openproject.org/wp/34514)\] diff --git a/docs/release-notes/11/11-3-0/README.md b/docs/release-notes/11/11-3-0/README.md index 3bbf6d9b53a6..bac6cff9810b 100644 --- a/docs/release-notes/11/11-3-0/README.md +++ b/docs/release-notes/11/11-3-0/README.md @@ -124,7 +124,7 @@ Users now have the option to **create backups of their OpenProject installation* - Changed: Add copy project form to APIv3 \[[#37091](https://community.openproject.org/wp/37091)\] - Changed: Attribute help text on dynamic form \[[#37092](https://community.openproject.org/wp/37092)\] - Changed: Improve design of checkboxes in formly forms \[[#37105](https://community.openproject.org/wp/37105)\] -- Changed: Improve design of Github tab \[[#37108](https://community.openproject.org/wp/37108)\] +- Changed: Improve design of GitHub tab \[[#37108](https://community.openproject.org/wp/37108)\] - Changed: Allow inviting users from project member administration for non admins \[[#37126](https://community.openproject.org/wp/37126)\] - Changed: Handle duplicate project identifiers in the backend \[[#37140](https://community.openproject.org/wp/37140)\] - Fixed: Unable to enter Boards module when work package module is disabled \[[#34794](https://community.openproject.org/wp/34794)\] @@ -183,7 +183,7 @@ Users now have the option to **create backups of their OpenProject installation* - Fixed: "(None)" option missing for parent project drop down select \[[#37398](https://community.openproject.org/wp/37398)\] - Fixed: Multi-select fields do not adjust height (cannot see values) \[[#37404](https://community.openproject.org/wp/37404)\] - Fixed: OpenProject backup completes partially with file permission errors \[[#37440](https://community.openproject.org/wp/37440)\] -- Fixed: Github user avatar not rendered correctly \[[#37444](https://community.openproject.org/wp/37444)\] +- Fixed: GitHub user avatar not rendered correctly \[[#37444](https://community.openproject.org/wp/37444)\] - Fixed: Password confirmation during backup token reset not working \[[#37445](https://community.openproject.org/wp/37445)\] - Fixed: Several problem with the header in mobile view \[[#37452](https://community.openproject.org/wp/37452)\] - Fixed: allowedValues for project user custom fields result in 400 bad request \[[#37453](https://community.openproject.org/wp/37453)\] diff --git a/docs/release-notes/11/11-4-0/README.md b/docs/release-notes/11/11-4-0/README.md index d2690f702a75..5ba523517c25 100644 --- a/docs/release-notes/11/11-4-0/README.md +++ b/docs/release-notes/11/11-4-0/README.md @@ -28,7 +28,7 @@ OpenProject 11.4.0 adds packaged installation support for Debian 11 "Bullseye". - Fixed: Wiki menu item scrolling does not work with two main wiki items \[[#38878](https://community.openproject.org/wp/38878)\] - Fixed: Imminent user limit warning shown prematurely \[[#38893](https://community.openproject.org/wp/38893)\] - Fixed: Custom S3 compatible upload providers blocked by CSP \[[#38900](https://community.openproject.org/wp/38900)\] -- Fixed: [Github Integration] Webhook fails for pull_request event without body \[[#38919](https://community.openproject.org/wp/38919)\] +- Fixed: [GitHub Integration] Webhook fails for pull_request event without body \[[#38919](https://community.openproject.org/wp/38919)\] - Fixed: IFC upload not working since attachment whitelisting \[[#38954](https://community.openproject.org/wp/38954)\] - Fixed: BIM seed are missing snapshots \[[#39009](https://community.openproject.org/wp/39009)\] - Fixed: Regression: Typing S while focus in viewer opens the OP global search \[[#39029](https://community.openproject.org/wp/39029)\] diff --git a/docs/release-notes/12/12-1-0/README.md b/docs/release-notes/12/12-1-0/README.md index 8c457b75608c..90ce53533abb 100644 --- a/docs/release-notes/12/12-1-0/README.md +++ b/docs/release-notes/12/12-1-0/README.md @@ -150,7 +150,7 @@ We added a new “Files” tab in the work package details. This way, you will h - Fixed: Users can't select public template projects in new project dialog \[[#40918](https://community.openproject.org/wp/40918)\] - Fixed: Meeting Time in iCalendar is wrong \[[#40941](https://community.openproject.org/wp/40941)\] - Fixed: Toolbar icons should be rendered in the "old" style and not the new rounded style (which is a work in progress) \[[#40957](https://community.openproject.org/wp/40957)\] -- Fixed: [Docker] - Gitlab integration plugin \[[#40959](https://community.openproject.org/wp/40959)\] +- Fixed: [Docker] - GitLab integration plugin \[[#40959](https://community.openproject.org/wp/40959)\] - Fixed: Project dropdown no longer autofocused \[[#40978](https://community.openproject.org/wp/40978)\] - Fixed: Not possible to copy work package to another project \[[#41005](https://community.openproject.org/wp/41005)\] - Fixed: Changed calendar styles applied to time entries component \[[#41013](https://community.openproject.org/wp/41013)\] diff --git a/docs/release-notes/13-3-0/README.md b/docs/release-notes/13-3-0/README.md index c501e37adc3f..dcfbdb794101 100644 --- a/docs/release-notes/13-3-0/README.md +++ b/docs/release-notes/13-3-0/README.md @@ -56,7 +56,7 @@ With this release, admins of an Enterprise edition can choose between manually o - Bugfix: Lookbook is broken \[[#51787](https://community.openproject.org/wp/51787)\] - Bugfix: Anonymous Users (without signing in) cannot load board content \[[#51850](https://community.openproject.org/wp/51850)\] - Bugfix: Misalignment in the dropdown on searching work packages \[[#51948](https://community.openproject.org/wp/51948)\] -- Bugfix: Remove colour in share modal is not correct \[[#52012](https://community.openproject.org/wp/52012)\] +- Bugfix: Remove color in share modal is not correct \[[#52012](https://community.openproject.org/wp/52012)\] - Bugfix: Timeouts as non privileged users \[[#52022](https://community.openproject.org/wp/52022)\] - Bugfix: WorkPackage query with baseline filter takes too much time for non-admins \[[#52156](https://community.openproject.org/wp/52156)\] - Bugfix: Multi-select user custom field broken in table \[[#52289](https://community.openproject.org/wp/52289)\] diff --git a/docs/release-notes/13-4-0/README.md b/docs/release-notes/13-4-0/README.md index d413ff082239..93e765da7f9c 100644 --- a/docs/release-notes/13-4-0/README.md +++ b/docs/release-notes/13-4-0/README.md @@ -88,7 +88,7 @@ Accessibility functionality: Convey to screenreaders when OAuth login has starte OpenProject version 13.4 now supports PDF exports with lists in table cells that are displayed correctly. Export a work package that contains a table with lists in it into a PDF. Here is an example of how this looks from now on: -![Work package with a table in the description field and how it looks when exportet as PDF](openproject-13-4-pdf-export-table-lists.png) +![Work package with a table in the description field and how it looks when exported as PDF](openproject-13-4-pdf-export-table-lists.png) ### WebAuthn/FIDO/U2F is added as a second factor @@ -139,13 +139,13 @@ Thanks to our great Community we can continuously offer more languages for OpenP - Bugfix: LDAP user can't be created if optional attributes are not mapped \[[#53327](https://community.openproject.org/wp/53327)\] - Bugfix: Page editor menu moves under the header \[[#53365](https://community.openproject.org/wp/53365)\] - Bugfix: Project folder is shown in the main menu based on the wrong permission for automatically managed project folders \[[#53367](https://community.openproject.org/wp/53367)\] -- Bugfix: Portuguese and Portuguese Brezilian should be distinct from each other \[[#53374](https://community.openproject.org/wp/53374)\] +- Bugfix: Portuguese and Portuguese Brazilian should be distinct from each other \[[#53374](https://community.openproject.org/wp/53374)\] - Bugfix: Blacklisted routes not working \[[#53399](https://community.openproject.org/wp/53399)\] - Bugfix: Incorrect spelling of GitLab module under project settings \[[#53434](https://community.openproject.org/wp/53434)\] - Bugfix: Webauthn fails on mobile Safari \[[#53442](https://community.openproject.org/wp/53442)\] - Bugfix: Rake secret task gone in 13.3.1 (breaking scripts & diverging from docs) \[[#53447](https://community.openproject.org/wp/53447)\] - Bugfix: WebAuth fails on iOS \[[#53494](https://community.openproject.org/wp/53494)\] -- Bugfix: WebAuthen not selectable on mobile \[[#53495](https://community.openproject.org/wp/53495)\] +- Bugfix: WebAuthn not selectable on mobile \[[#53495](https://community.openproject.org/wp/53495)\] diff --git a/docs/release-notes/3/3-0-16/README.md b/docs/release-notes/3/3-0-16/README.md index ac8cd5306918..c5ab39238e14 100644 --- a/docs/release-notes/3/3-0-16/README.md +++ b/docs/release-notes/3/3-0-16/README.md @@ -28,6 +28,6 @@ bugs! For a complete list of changes, please refer to the [Changelog v3.0.16](https://community.openproject.org/versions/544) or have a look at -[Github](https://github.com/opf/openproject/tree/v3.0.16). +[GitHub](https://github.com/opf/openproject/tree/v3.0.16). diff --git a/docs/release-notes/4/4-0-2/README.md b/docs/release-notes/4/4-0-2/README.md index dc4c12179dca..b517b918ff79 100644 --- a/docs/release-notes/4/4-0-2/README.md +++ b/docs/release-notes/4/4-0-2/README.md @@ -36,4 +36,4 @@ A big thanks to everyone involved in fixing and reporting those bugs! For a complete list of changes, please refer to the [Changelog v4.0.2](https://community.openproject.org/versions/532) or to -[Github](https://github.com/opf/openproject/tree/v4.0.2). +[GitHub](https://github.com/opf/openproject/tree/v4.0.2). diff --git a/docs/release-notes/8/8-0-2/README.md b/docs/release-notes/8/8-0-2/README.md index ee9d09ba74b6..bb055bfa229c 100644 --- a/docs/release-notes/8/8-0-2/README.md +++ b/docs/release-notes/8/8-0-2/README.md @@ -45,7 +45,7 @@ newest version. #### Contributions -Thanks to Github users @storm2513 and @akasparas for providing bugfixes +Thanks to GitHub users @storm2513 and @akasparas for providing bugfixes as pull requests [on our GitHub project](https://github.com/opf/openproject). A big thanks to community members for reporting bugs and helping us identifying and providing diff --git a/docs/security-and-privacy/processing-of-personal-data/README.md b/docs/security-and-privacy/processing-of-personal-data/README.md index e56cc6be77b9..b361b802270e 100644 --- a/docs/security-and-privacy/processing-of-personal-data/README.md +++ b/docs/security-and-privacy/processing-of-personal-data/README.md @@ -580,7 +580,7 @@ flowchart LR subgraph openproject[OpenProject] direction TB - opgithubintegration[Github integration] --- workpackagesmodule[Work packages module] + opgithubintegration[GitHub integration] --- workpackagesmodule[Work packages module] end @@ -635,7 +635,7 @@ flowchart LR #### Purpose - Connect merge requests in GitLab with work packages in OpenProject. -- Connect issues in GitLab with work packages in OpenPrject. +- Connect issues in GitLab with work packages in OpenProject. - Show the status of merge requests in related work packages. #### Processed data diff --git a/docs/system-admin-guide/file-storages/README.md b/docs/system-admin-guide/file-storages/README.md index 5c36009d83d9..da8a50c8a7d6 100644 --- a/docs/system-admin-guide/file-storages/README.md +++ b/docs/system-admin-guide/file-storages/README.md @@ -3,7 +3,7 @@ sidebar_navigation: title: File storages priority: 830 description: File storages in OpenProject. -keywords: file storages, Nextcloud setup, Nextcloud integration, OneDrive setup, Sharepoint setup, OneDrive, Sharepoint +keywords: file storages, Nextcloud setup, Nextcloud integration, OneDrive setup, SharePoint setup, OneDrive, SharePoint --- # File storages diff --git a/docs/system-admin-guide/integrations/README.md b/docs/system-admin-guide/integrations/README.md index d4b645ad04b4..1285fe09def6 100644 --- a/docs/system-admin-guide/integrations/README.md +++ b/docs/system-admin-guide/integrations/README.md @@ -46,7 +46,7 @@ OpenProject offers integration with Nextcloud for file storage and collaboration ## OneDrive/SharePoint (Enterprise add-on) -OpenProject offers an integration with OneDrive/Sharepoint for file storage and collaboration. You can find more information about [setting up the integration with OneDrive/SharePoint](./one-drive) and [using the integration](../../user-guide/file-management/one-drive-integration/). +OpenProject offers an integration with OneDrive/SharePoint for file storage and collaboration. You can find more information about [setting up the integration with OneDrive/SharePoint](./one-drive) and [using the integration](../../user-guide/file-management/one-drive-integration/). > **Note**: OneDrive/SharePoint integration is an Enterprise add-on and can only be used with [Enterprise cloud](../../enterprise-guide/enterprise-cloud-guide/) or [Enterprise on-premises](../../enterprise-guide/enterprise-on-premises-guide/). An upgrade from the free Community edition is easy and helps support OpenProject. diff --git a/docs/system-admin-guide/integrations/github-integration/README.md b/docs/system-admin-guide/integrations/github-integration/README.md index fff564826bc6..8db04cc83cb0 100644 --- a/docs/system-admin-guide/integrations/github-integration/README.md +++ b/docs/system-admin-guide/integrations/github-integration/README.md @@ -28,7 +28,7 @@ Pull request activities will also show up in the Activity tab when the pull requ * merged * closed -![Github comments on work package](workpackage-github-comments.png) +![GitHub comments on work package](workpackage-github-comments.png) ## Create a pull request diff --git a/docs/system-admin-guide/integrations/gitlab-integration/README.md b/docs/system-admin-guide/integrations/gitlab-integration/README.md index de18ed91a139..d4a8e2d7ffc2 100644 --- a/docs/system-admin-guide/integrations/gitlab-integration/README.md +++ b/docs/system-admin-guide/integrations/gitlab-integration/README.md @@ -13,7 +13,7 @@ OpenProject offers an integration with GitLab merge requests to link software de OpenProject work packages will directly display information from GitLab in a separate tab. -![Gitlab tab in an OpenProject work package](gitlab-tab.png) +![GitLab tab in an OpenProject work package](gitlab-tab.png) The tab shows all merge requests (MR) linked to a work package with the corresponding status (e.g. 'Ready' or 'Merged') as well as the state (e.g. 'success' or 'queued') of the GitLab actions configured to run for a MR. MRs and work packages are in an n:m relationship, so a work package can be linked to multiple merge requests and a merge request can be linked to multiple work packages. @@ -100,7 +100,7 @@ You can now publish your branch (you can also do this later, after making the ch With the branch opened, you can start the actual development work using your preferred tool to alter your codebase. -![Gitlab changes in a merge request changes](gitlab-changes.png) +![GitLab changes in a merge request changes](gitlab-changes.png) Once you are satisfied with the changes you can create a commit. Within the 'Git snippets' menu, OpenProject suggests a commit message for you based on the title and the URL of the work package. diff --git a/docs/user-guide/file-management/README.md b/docs/user-guide/file-management/README.md index 9283527bd02c..e881b5bce977 100644 --- a/docs/user-guide/file-management/README.md +++ b/docs/user-guide/file-management/README.md @@ -12,7 +12,7 @@ keywords: files, attachment, Nextcloud, OneDrive, SharePoint |--------------------------------------------------------------------------------------|---------------------------------------------------------------------------| | [Manual upload](#manual-upload) | How to manually upload files to work packages in OpenProject. | | [Nextcloud integration](#nextcloud-integration) | How to manage files using Nextcloud integration in OpenProject. | -| [OneDrive/SharePoint integration](#onedrivesharepoint-integration-enterprise-add-on) | How to manage files using OneDrive/Sharepoint integration in OpenProject. | +| [OneDrive/SharePoint integration](#onedrivesharepoint-integration-enterprise-add-on) | How to manage files using OneDrive/SharePoint integration in OpenProject. | | [File management FAQs](./file-management-faq) | Frequently asked questions on file management in OpenProject. | There are several ways of adding or linking files to work packages in OpenProject. You can manually attach files directly to work packages or use one of the integrations with file management systems. diff --git a/docs/user-guide/file-management/one-drive-integration/README.md b/docs/user-guide/file-management/one-drive-integration/README.md index 9b29dce4242e..8344e260a66b 100644 --- a/docs/user-guide/file-management/one-drive-integration/README.md +++ b/docs/user-guide/file-management/one-drive-integration/README.md @@ -33,7 +33,7 @@ To begin using this integration, you will need to first connect your OpenProject 1. Select any work package. Go to the **Files tab** and, within the correct file storage section, click on **Storage login** button. - ![Login to Sharepoint storage from an OpenProject work package](openproject_onedrive_login_to_storage.png) + ![Login to SharePoint storage from an OpenProject work package](openproject_onedrive_login_to_storage.png) 2. You will see a Microsoft login prompt asking you to log in. Enter your credentials and log in. 3. Once you have logged in, you will automatically return to the work package in OpenProject and see that you can now start uploading and linking files. @@ -71,7 +71,7 @@ Once you have selected or dropped the files you would like to upload, you will n > **Info**: The default location that opens in the file picker is the file root of the configured OneDrive/SharePoint drive. -![Selection a Sharepoint location to upload a file from OpenProject](openproject_onedrive_select_location.png) +![Selection a SharePoint location to upload a file from OpenProject](openproject_onedrive_select_location.png) You can click on folders you see to navigate to them. Helpful breadcrumbs show you where you are in the folder hierarchy. @@ -83,7 +83,7 @@ To save the files you uploaded to the currently open folder, click on the **Choo The selected file is uploaded to your OneDrive/SharePoint instance and linked to the current work package. It appears under the name of the file storage. -![File successfully uploaded to Sharepoint storage](openproject_onedrive_file_uploaded.png) +![File successfully uploaded to SharePoint storage](openproject_onedrive_file_uploaded.png) If a file has been deleted on the OneDrive/SharePoint file storage it will still be displayed under the **Files** tab. However it will not be selectable. If you hover over a deleted file you will see the message indicating that the file could not be found. @@ -95,7 +95,7 @@ If a file has been deleted on the OneDrive/SharePoint file storage it will still If you wish to unlink any linked file or folder, hover it in the list of linked files and click on the **Unlink** icon. -![Unlink a linked Sharepoint file from an OpenProject work package](openproject_onedrive_download_file.png) +![Unlink a linked SharePoint file from an OpenProject work package](openproject_onedrive_download_file.png) Respectively in order to download a file, click on the **Download icon** in the context menu of the file link in the list of the linked files. diff --git a/modules/gitlab_integration/README.md b/modules/gitlab_integration/README.md index f48a136354f4..436546b2bf6d 100644 --- a/modules/gitlab_integration/README.md +++ b/modules/gitlab_integration/README.md @@ -2,7 +2,7 @@
-Based on the OpenProject Github Integration, this plugin offers the same functionalities plus other new features. This is the first version that includes the visualization of the status of the *Pipelines* (by now, it is considered in Beta status). You can test it by activating the Pipelines event in the GitLab webhook. Just keep in mind that not all pipelines will be reflected in OpenProject, only Merge Request type pipelines (for more information see the GitLab issue https://gitlab.com/gitlab-org/gitlab/-/issues/345028). Any feedback about the pipelines feature would be very appreciated, whether it works or if issues arise (you can use this ticket https://github.com/btey/openproject-gitlab-integration/issues/43). +Based on the OpenProject GitHub Integration, this plugin offers the same functionalities plus other new features. This is the first version that includes the visualization of the status of the *Pipelines* (by now, it is considered in Beta status). You can test it by activating the Pipelines event in the GitLab webhook. Just keep in mind that not all pipelines will be reflected in OpenProject, only Merge Request type pipelines (for more information see the GitLab issue https://gitlab.com/gitlab-org/gitlab/-/issues/345028). Any feedback about the pipelines feature would be very appreciated, whether it works or if issues arise (you can use this ticket https://github.com/btey/openproject-gitlab-integration/issues/43). In this version it has also been implemented that **all linked or referenced** Issues appear in the GitLab tab (https://github.com/btey/openproject-gitlab-integration/issues/34). The opportunity has also been taken to redesign how the information is presented so that it is visually easy to read and at the same time can continue to provide all the information, including labels and pipeline status. @@ -15,7 +15,7 @@ If there are labels related to the Issue or MR, a button with the label icon wil ## Overview OpenProject module for integration with GitLab: -* Latest Gitlab release tested: **16.6.2** +* Latest GitLab release tested: **16.6.2** * Latest OpenProject release tested: **13.1.2** (for OP v13.0.X use v2.1.2) The reference system is based on the same system as for GitHub integration. You can use a link to the work package or just use “OP#87” or "PP#87" in the title/description of the Issue/MR in GitLab. @@ -136,7 +136,7 @@ A typical workflow on GitLab side would be: ## Configuration -You will have to configure both **OpenProject** and **Gitlab** for the integration to work. +You will have to configure both **OpenProject** and **GitLab** for the integration to work. In case of **Docker** installation, follow the official OpenProject documentation [here](https://www.openproject.org/docs/installation-and-operations/installation/docker/#openproject-plugins). If for some reason the installation with Docker described in the official documentation does not work for you, you can try building your own docker image: * Clone from the Openproject Repo: `git clone https://github.com/opf/openproject.git --branch=stable/13 --depth=1 .` @@ -147,11 +147,11 @@ In case of **Docker** installation, follow the official OpenProject documentatio In case of **DEB/RPM** based instalation, follow the official OpenProject documentation [here](https://www.openproject.org/docs/installation-and-operations/configuration/plugins/). -In case of [**manual**](https://www.openproject.org/docs/installation-and-operations/installation/manual/) installation, this plugin should be installed in the same place as the Github plugin that comes bundled with OpenProject. +In case of [**manual**](https://www.openproject.org/docs/installation-and-operations/installation/manual/) installation, this plugin should be installed in the same place as the GitHub plugin that comes bundled with OpenProject. -- **Github plugin path:** `modules/github_integration` +- **GitHub plugin path:** `modules/github_integration` -- **Path to put Gitlab plugin:** `modules/gitlab_integration` +- **Path to put GitLab plugin:** `modules/gitlab_integration` But first you must modify **Gemfile.lock** and **Gemfile.modules** so that OpenProject detects the new module. @@ -198,13 +198,13 @@ bundle config set deployment First you will need to create a user in OpenProject that will make the comments. The user will have to be added to each project with a role that allows them to comment on work packages and change status. -Once the user is created you need to generate an OpenProject API token for it to use later on the Gitlab side: +Once the user is created you need to generate an OpenProject API token for it to use later on the GitLab side: * Login as the newly created user. * Go to My Account (click on Avatar in top right corner). * Go to Access Token. * Click on generate in the API row. -* Copy the generated key. You can now configure the necessary webhook in Gitlab. +* Copy the generated key. You can now configure the necessary webhook in GitLab. ### The webhook in GitLab @@ -227,7 +227,7 @@ You need to configure just two things in the webhook: Now the integration is set up on both sides and you can use it. -> **Note:** If you are installing and configuring OpenProject on the same server as GitLab you will need to enable in Gitlab the option [`Allow requests to the local network from web hooks and services`](https://docs.gitlab.com/ee/security/webhooks.html#allow-requests-to-the-local-network-from-webhooks-and-integrations) so that it can send the data locally to the OpenProject webhook since they will be on the same machine. +> **Note:** If you are installing and configuring OpenProject on the same server as GitLab you will need to enable in GitLab the option [`Allow requests to the local network from web hooks and services`](https://docs.gitlab.com/ee/security/webhooks.html#allow-requests-to-the-local-network-from-webhooks-and-integrations) so that it can send the data locally to the OpenProject webhook since they will be on the same machine. ## How to report bugs or issues