Content
View differences
Updated by Dominic Bräunlein 3 days ago
####
* Before OpenProject project members are able to access, link to and create wiki pages in XWiki, an administrator has to set up the integration. This is a one-time operation per wiki instance.
* There is a new entry in the administration settings, at _Administration → Wiki platforms_
* This will display all existing integrations with wiki platforms.
* By default it has only the internal Wiki.
* The internal Wiki can be enabled/disabled on the instance and is enabled by default.
* Administrators can click on the **\+ Wiki platform** button and select "XWiki" to be taken to the "New XWiki instance" page where they can begin configuring the integration.
* Setting up an XWiki-OpenProject integration involves two main steps on the OpenProject side, through which the users are guided step-by-step:
* In _General information_, the admin user gives the XWiki instance to which they're connecting a name and defines the host URL.
* In _OAuth applications_, there is an exchange of OAuth client IDs and secrets between the two applications.
* OpenProject will generate its own values that the user will have to paste into the OpenProject integration setup flow in XWiki.
* XWiki will, in turn, also generate a client ID and secret that the user will be asked to enter on this page.
* In _My account / Access tokens_ the current user can revoke/delete each access token that was granted to each XWiki instance.
####
#### **Visuals**
**Empty "Wiki platforms" page :**
(Needs update: The screen should display _OpenProject Internal Wiki,_ which can be enabled/disabled on the instance)
<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/107167/content">
**Step 1: General information:**
<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/107168/content">
**Step 2A: OAuth client IDs and secrets (OpenProject-generated):**
<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/107169/content">
**Step 2B: OAuth client IDs and secrets (XWiki-generated):**
<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/107170/content">
**Step 3: Automatically managed project spaces (Not part of the initial scope of implementation offer):**
<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/107171/content">
**XWiki instance added:**
<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/107172/content">
**Health checks - all okay:**
<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/107173/content">
**Health check - problems detected:**
**<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/918228/content">**
<br>
####
#### **Figma mockups**
* **Integration setup:** [https://www.figma.com/design/m0Aj4o5upRvD2kdSB7mMQT/XWiki-Integration?node-id=304-33134&t=8u8yBfPkViXQeEFt-4](https://www.figma.com/design/m0Aj4o5upRvD2kdSB7mMQT/XWiki-Integration?node-id=304-33134&t=8u8yBfPkViXQeEFt-4)
* **Health checks:** [https://www.figma.com/design/m0Aj4o5upRvD2kdSB7mMQT/XWiki-Integration?node-id=304-44961&t=8u8yBfPkViXQeEFt-4](https://www.figma.com/design/m0Aj4o5upRvD2kdSB7mMQT/XWiki-Integration?node-id=304-44961&t=8u8yBfPkViXQeEFt-4)
* Before OpenProject project members are able to access, link to and create wiki pages in XWiki, an administrator has to set up the integration. This is a one-time operation per wiki instance.
* There is a new entry in the administration settings, at _Administration → Wiki platforms_
* This will display all existing integrations with wiki platforms.
* By default it has only the internal Wiki.
* The internal Wiki can be enabled/disabled on the instance and is enabled by default.
* Administrators can click on the **\+ Wiki platform** button and select "XWiki" to be taken to the "New XWiki instance" page where they can begin configuring the integration.
* Setting up an XWiki-OpenProject integration involves two main steps on the OpenProject side, through which the users are guided step-by-step:
* In _General information_, the admin user gives the XWiki instance to which they're connecting a name and defines the host URL.
* In _OAuth applications_, there is an exchange of OAuth client IDs and secrets between the two applications.
* OpenProject will generate its own values that the user will have to paste into the OpenProject integration setup flow in XWiki.
* XWiki will, in turn, also generate a client ID and secret that the user will be asked to enter on this page.
* In _My account / Access tokens_ the current user can revoke/delete each access token that was granted to each XWiki instance.
####
#### **Visuals**
**Empty "Wiki platforms" page :**
(Needs update: The screen should display _OpenProject Internal Wiki,_ which can be enabled/disabled on the instance)
<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/107167/content">
**Step 1: General information:**
<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/107168/content">
**Step 2A: OAuth client IDs and secrets (OpenProject-generated):**
<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/107169/content">
**Step 2B: OAuth client IDs and secrets (XWiki-generated):**
<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/107170/content">
**Step 3: Automatically managed project spaces (Not part of the initial scope of implementation offer):**
<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/107171/content">
**XWiki instance added:**
<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/107172/content">
**Health checks - all okay:**
<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/107173/content">
**Health check - problems detected:**
**<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/918228/content">**
<br>
####
#### **Figma mockups**
* **Integration setup:** [https://www.figma.com/design/m0Aj4o5upRvD2kdSB7mMQT/XWiki-Integration?node-id=304-33134&t=8u8yBfPkViXQeEFt-4](https://www.figma.com/design/m0Aj4o5upRvD2kdSB7mMQT/XWiki-Integration?node-id=304-33134&t=8u8yBfPkViXQeEFt-4)
* **Health checks:** [https://www.figma.com/design/m0Aj4o5upRvD2kdSB7mMQT/XWiki-Integration?node-id=304-44961&t=8u8yBfPkViXQeEFt-4](https://www.figma.com/design/m0Aj4o5upRvD2kdSB7mMQT/XWiki-Integration?node-id=304-44961&t=8u8yBfPkViXQeEFt-4)