From 347069df0c35356139720647417d5ed605185f9f Mon Sep 17 00:00:00 2001 From: Maya Berdygylyjova Date: Tue, 19 Mar 2024 08:56:12 +0100 Subject: [PATCH] update GitLab docs --- .../integrations/gitlab-integration/README.md | 20 +-------- .../errors-and-troubleshooting/README.md | 45 +++++++++++++++++++ 2 files changed, 47 insertions(+), 18 deletions(-) create mode 100644 docs/user-guide/file-management/errors-and-troubleshooting/README.md diff --git a/docs/system-admin-guide/integrations/gitlab-integration/README.md b/docs/system-admin-guide/integrations/gitlab-integration/README.md index f20d03b93726..de18ed91a139 100644 --- a/docs/system-admin-guide/integrations/gitlab-integration/README.md +++ b/docs/system-admin-guide/integrations/gitlab-integration/README.md @@ -106,12 +106,7 @@ Once you are satisfied with the changes you can create a commit. Within the 'Git ![Copy a Git commit message in OpenProject](openproject-system-guide-gitlab-integration-git-snippets-commit-message.png) -A URL pointing to a work package in the merge request description or a comment will link the two. The link needs to be in the MR and not in a commit, but GitLab will use the first commit message as the proposed branch description (as long as there is only one commit). - -!!DO NOT MERGE!! - -Should we already mentioned that OP# as a reference in an Issue or MR title works too? When I first read the documentation I missed the part about it later in the text and I thought only linking does work. -!!DO NOT MERGE END!! +A URL pointing to a work package in the merge request description or a comment will link the two. The link needs to be in the MR and not in a commit, but GitLab will use the first commit message as the proposed branch description (as long as there is only one commit). Alternatively you can also use 'OP#' as a work package reference in an issue or a MR title, in this case "OP#388", where 388 is the ID of the work package. ![Commit message in a Git client](openproject-system-guide-gitlab-integration-commit-message-in-client.png) @@ -121,18 +116,7 @@ Once the changes are made, you can create your merge request. Title and comment The branch description can be amended before a MR is created giving the opportunity to further describe the changes. To help with that, it is also possible to copy parts of the work package description since the description can be displayed in the markdown format. Links to additional work packages can also be included in the MR description. -Rather than inserting a link to the work package you can also reference it just by adding "OP#388" to the pull request's description where 388 is the ID of the work package - -!!DO NOT MERGE!! - -Maybe interesting for our docu too? -From https://github.com/btey/openproject-gitlab-integration?tab=readme-ov-file#difference-between-op-and-pp - -Difference between OP and PP - -If you use OP# as a reference in an Issue or MR title, all comments will be replicated in OpenProject. However, sometimes you may only want to keep information about the status of an Issue/MR in OpenProject, but you don't want your comments to be published. In this case, you can use PP# as a reference. This way the comments will not be published in OpenProject. But if at any time one of your comments in a private Issue/MR is of interest to you to be published in OpenProject you can use OP# directly in that comment. So only that comment will be published in OpenProject. The rest of the comments will remain private and will not be published. - -!!DO NOT MERGE END!! +If you use OP# as a reference in an Issue or MR title, all comments will be replicated in OpenProject. However, sometimes you may only want to keep information about the status of an Issue/MR in OpenProject without your comments being published. In this case, you can use "PP#" as a reference. For example "PR#388". This way the comments will not be published in OpenProject. If you only want to publish one of the comments from a private Issue/MR, you can use "OP#" directly in that comment. This way only that specific comment will be published in OpenProject, but the rest of the comments will remain private. [Read more](https://github.com/btey/openproject-gitlab-integration?tab=readme-ov-file#difference-between-op-and-pp). ![Open a GitLab merge request](openproject-system-guide-gitlab-integration-create-mr-detail.png) diff --git a/docs/user-guide/file-management/errors-and-troubleshooting/README.md b/docs/user-guide/file-management/errors-and-troubleshooting/README.md new file mode 100644 index 000000000000..ac1d28fff212 --- /dev/null +++ b/docs/user-guide/file-management/errors-and-troubleshooting/README.md @@ -0,0 +1,45 @@ +--- +sidebar_navigation: + title: File management Troubleshooting + priority: 002 +description: Possible file management errors and troubleshooting in OpenProject. +keywords: files, attachment, Nextcloud, OneDrive, SharePoint, error, troubleshooting +--- + +# Possible errors and troubleshooting + +## + +## Nextcloud specific errors and troubleshooting + +### No permission to see this file + +If you are unable to see the details of a file or are unable to open some of the files linked to a work package, it could be related to your Nextcloud account not having the necessary permissions. In such a case, you will be able to see the name, time of last modification and the name of the modifier but you will not be able to perform any further actions. To open or access these files, please contact your Nextcloud administrator or the creator of the file so that they can grant you the necessary permissions. + +![Permissions missing error](1_1_01-Not_all_files_available.png) + +### User not logged in to Nextcloud + +If you see the words "Login to Nextcloud" where you would normally see a list of linked files in the Files tab in OpenProject, it is because you have logged out of (or have been automatically logged out of) Nextcloud. Alternatively, you could be logged in with a different account than the one you set up to use with OpenProject. + +In this case, you will still be able to see the list of linked files, but not perform any actions. To restore full functionality, simply log back in to your Nextcloud account. + +![Login error in OpenProject](1_0_01-Log_in_error.png) + +### Connection error + +If you see the words "No Nextcloud connection" in the Files tab in OpenProject, your OpenProject instance is having trouble connecting to your Nextcloud instance. This could be due to a number of different reasons. Your best course of action is to get in touch with the administrator of your OpenProject and Nextcloud instances to identify and to resolve the issue. + +![OpenProject connection error](1_0_02-Connection_broken.png) + +### File fetching error + +In rare occasions, it is possible for the integration to not be able to fetch all the details of all linked files. A simple page refresh should solve the issue. Should the error persist, please contact administrator of your OpenProject and Nextcloud instances. + +![OpenProject file fetching error](1_0_03-Fetching_error.png) + +### Project notifications are not displayed in Nextcloud + +If OpenProject notifications are not properly displayed in Nextcloud, navigate to *Administration settings → Basic settings → Background jobs* and ensure that _Cron_ is selected. + +![Nextcloud notifications not displayed](Cron_job_settings.png)