Merge pull request #16286 from opf/task/56644-144-documentation-updat…

…e-pageheaders-and-subheaders-in-the-admin-pages

[#56644] 14.4 Documentation: Update PageHeaders & SubHeaders in the A…

docs/enterprise-guide/enterprise-cloud-guide/invoices-and-billing-history/README.md

@@ -21,7 +21,7 @@ For invoices via bank transfer, the money needs to be paid via bank transfer to
 
 ## Payment history and download invoices
 
-If you want to see the billing history or download older invoices of your Enterprise cloud edition, navigate to -> *Administration* -> *Billing* within your system's Administration.
+If you want to see the billing history or download older invoices of your Enterprise cloud edition, navigate to *Administration* -> *Billing* within your system's Administration.
 
 Click the green **Manage button** at the top right.
 

docs/enterprise-guide/enterprise-cloud-guide/manage-cloud-subscription/README.md

@@ -8,7 +8,7 @@ keywords: enterprise cloud edition, subscription, address, payment method, invoi
 
 # Manage your OpenProject Enterprise cloud subscription
 
-If you want to make changes to your subscription (Up- or downgrade, cancel, change your address or payment method), navigate to -> *Administration* -> *Billing* within your system's Administration.
+If you want to make changes to your subscription (Up- or downgrade, cancel, change your address or payment method), navigate to *Administration* -> *Billing* within your system's Administration.
 
 Click the green **Manage button**.
 

docs/system-admin-guide/announcement/README.md

@@ -14,12 +14,12 @@ You can configure **announcements in OpenProject** which will be displayed for a
 3. **Set the announcement to active**. Only then will the announcement be shown.
 4. **Save** your changes.
 
-![Sys-admin-announcement](Sys-admin-announcement-1579796618282.png)
+![Define an announcement in OpenProject administration](openproject_system_admin_guide_announcement.png)
 
 The active announcement will be displayed until the defined date to users **on the login screen**.
 
-![Sys-admin-downtime-announcement](Sys-admin-downtime-announcement.png)
+![An active announcement displayed on the OpenProject login screen](openproject_system_admin_guide_announcement_login_screen.png)
 
 Also, the active announcement will be displayed until the defined date to users **on the application start page**.
 
-![Sys-admin-announcement-start-page](Sys-admin-announcement-start-page.png)
+![An active announcement displayed on the OpenProject application start page](openproject_system_admin_guide_announcement_homepage.png)

docs/system-admin-guide/api-and-webhooks/README.md

@@ -1,7 +1,7 @@
 ---
 sidebar_navigation:
   title: API and webhooks
-  priority: 910
+  priority: 900
 description: Configure APIs and webhooks in OpenProject.
 keywords: api webhooks
 ---
@@ -13,7 +13,7 @@ Navigate to **Administration → API and webhooks**.
 
 ## API
 
-![Administration settings API](admin-api.png)
+![API settings in OpenProject administration](openproject_system_admin_guide_api.png)
 
 Here, you can manage the **REST web service** to selectively control whether foreign applications may access your OpenProject API endpoints from within the browser. You can set the **maximum page size** the API will respond with. It will not be possible to perform API requests that return more values on a single page. You can also enable **write access to read-only attributes**, which will allow administrators to write static read-only attributes during creation, such as *createdAt* and *author*. 
 
@@ -40,7 +40,7 @@ You can set up webhooks for OpenProject in order to integrate OpenProject with o
 
 Press the green **+ Webhook** button to add a new webhook to OpenProject.
 
-![Add a new webhook in OpenProject administration](incoming-vs-outgoing-webhooks.png)
+![Webhooks in OpenProject administration](openproject_system_admin_guide_webhooks.png)
 
 You can configure the following options for webhooks:
 
@@ -51,9 +51,6 @@ You can configure the following options for webhooks:
 5. **Enable** if **the webhook** should be active.
 6. **Set the events** for which the webhook should be activate, i.e. webhook for updating or creating projects or work packages, or for creating time entries.
 7. **Select for which projects the webhook should be active**. You can choose all projects or only specific projects. For example if you select the project "System admin guide", an event (ie. create a new time entry) will be fired via the webhook. This will only happen if a user logs time within the selected projects.
+8. Press the green **Create** button to save your changes (you may nee to scroll down to find it). There you can also cancel your input.
 
-![steps-to-create-a-webhook](steps-to-create-a-webhook.png)
-
-Press the green **Create** button to save your changes (you may nee to scroll down to find it). There you can also cancel your input.
-
-![create-button-new-webhook](create-button-new-webhook.png)
+![Add a new webhook in OpenProject administration](openproject_system_admin_guide_api_new_webhook.png)

docs/system-admin-guide/attribute-help-texts/README.md

@@ -1,7 +1,7 @@
 ---
 sidebar_navigation:
   title: Attribute help texts
-  priority: 960
+  priority: 950
 description: Learn how to set attribute help texts in OpenProject
 keywords: attribute help texts, help texts for projects and work packages
 
@@ -24,9 +24,9 @@ This way you will reduce wrong entries for attributes. This is especially releva
 | [Projects](#projects)                                                       | Where will Attribute help texts for projects be used?      |
 | [WYSIWYG editor](#wysiwyg-editor)                                           | Where can Attribute help texts be displayed?               |
 
-Navigate to -> *Administration* -> *Attribute help texts* to set up help texts for attributes and custom fields in work packages and projects. Here you can add, edit and delete Attribute help texts.
+Navigate to *Administration* -> *Attribute help texts* to set up help texts for attributes and custom fields in work packages and projects. Here you can add, edit and delete Attribute help texts.
 
-![image-20201006165832885](image-20201006165832885.png)
+![Attribute help texts in OpenProject administration](openproject_system_admin_guide_attribute_help_texts_overview.png)
 
 ## Add Attribute help texts
 
@@ -37,40 +37,41 @@ To add an Attribute help texts for custom fields click on the green **+ Attribut
 3. Add **files**, e.g. excerpts from a process manual
 4. **Save** your changes.
 
-![image-20201006171019961](image-20201006171019961.png)
+![Add a new attribute help text in OpenProject administration](openproject_system_admin_guide_attribute_help_texts_add.png)
 
-Be aware that the help text will be visible in all projects.
+> [!NOTE]
+> Please be aware that the help text will be visible in all projects.
 
 Once you configured the help text for an attribute, project members can see the explanation. The will see a question mark item next to the attribute.
 
 When the users click on it, they see the description for this attribute.
 
-![attribute help text description](image-20200122102249268.png)
+![Attribute help text description example](openproject_system_admin_guide_attribute_help_texts_example.png)
 
 ## Edit or delete Attribute help texts
 
-Navigate to -> *Administration* -> *Work packages* -> *Attribute help texts* in order to edit or remove an attribute help text.
+Navigate to *Administration* -> *Work packages* -> *Attribute help texts* in order to edit or remove an attribute help text.
 
 1. Click on the **name** of the attribute to edit an existing attribute help text.
 2. Click on the **delete icon** to delete an attribute help text.
 
-![Sys-admin-edit-delete-attribute-help-texts](Sys-admin-edit-delete-attribute-help-texts.png)
+![Edit or delete help attribute texts in OpenProject administration](openproject_system_admin_guide_attribute_help_texts_edit_delete.png)
 
 ## Work packages
 
 The Attribute help texts for work packages will be displayed in the [details view](../../user-guide/work-packages/work-package-views/#split-screen-view) (as in the screenshot below) and in the [full screen view](../../user-guide/work-packages/work-package-views/#full-screen-view). They will help the users (e.g. the project managers) understand what kind of information to put in which fields.
 
-![Sys-admin-attribute-help-texts-open](Sys-admin-attribute-help-texts-open.png)
+![Example of attribute help text in a work package view in OpenProject](openproject_system_admin_guide_attribute_help_texts_example_wp.png)
 
 ## Projects
 
 The Attribute help texts for projects will be displayed in the Project details widget in the [Project overview](../../user-guide/project-overview/) (as in the first screenshot below) and in the [Project settings](../../user-guide/projects/project-settings/project-information/) (as in the second screenshot below).
 
 They will help the users (e.g. the project managers) understand what kind of information to put in which fields.
 
-![Attribute help texts project overview](image-20201007112035870.png)
+![Attribute help texts on a project overview page](openproject_system_admin_guide_attribute_help_texts_project_overview_page.png)
 
-![Attribute help texts project information](image-20201007112741049.png)
+![Attribute help texts project information page](openproject_system_admin_guide_attribute_help_texts_project_settings_page.png)
 
 ## WYSIWYG editor
 

docs/system-admin-guide/authentication/README.md

@@ -1,7 +1,7 @@
 ---
 sidebar_navigation:
   title: Authentication
-  priority: 900
+  priority: 890	
 description: Authentication in OpenProject.
 keywords: authentication
 ---

docs/system-admin-guide/authentication/oauth-applications/README.md

@@ -8,7 +8,7 @@ keywords: OAuth application settings
 # OAuth applications
 
 To configure OpenProject to act as a server to an
-OAuth client applications, please navigate to -> *Administration* -> *Authentication* -> *OAuth applications*.
+OAuth client applications, please navigate to *Administration* -> *Authentication* -> *OAuth applications*.
 
 ## Add a new authentication application for OAuth
 

docs/system-admin-guide/authentication/openid-providers/README.md

@@ -14,7 +14,7 @@ keywords: OpenID providers
 | [Custom OpenID Connect Providers](#custom-openid-connect-providers) | Configuration of additional OpenID Connect providers.        |
 | [Troubleshooting](#troubleshooting)                          | Common complications when using OpenID as SSO.               |
 
-To activate and configure OpenID providers in OpenProject, navigate to -> *Administration* -> *Authentication* and choose -> *OpenID providers*.
+To activate and configure OpenID providers in OpenProject, navigate to *Administration* -> *Authentication* and choose -> *OpenID providers*.
 
 ## Add a new authentication application for oauth
 
@@ -30,7 +30,7 @@ You can configure the following options.
 4. Enter the **Secret**.
 5. Optionally, if you want to honor the system-wide self-registration setting, enable "Limit self registration".
 When checked, users will be created according to the [self-registration setting](../authentication-settings).
-6. Press the blue **create** button.
+6. Press the **create** button.
 
 ## Google Workspace
 
@@ -82,7 +82,7 @@ After pressing **CREATE** you will get a pop-up window like the following
 ### Step 3: Add Google as an OpenID Provider to OpenProject
 
 1. Login as OpenProject Administrator
-2. navigate to -> *Administration* -> *Authentication* and choose -> *OpenID providers*.
+2. Navigate to *Administration* -> *Authentication* and choose -> *OpenID providers*.
    1. **Name** Choose Google
    2. **Display Name** (e.g. **EXAMPLE.COM SSO**)
    3. **Identifier** (**Client ID** from step 2)

docs/system-admin-guide/authentication/recaptcha/README.md

@@ -7,7 +7,7 @@ keywords: reCAPTCHA
 ---
 # reCAPTCHA configuration
 
-To activate and **configure reCAPTCHA** for OpenProject, navigate to -> *Administration* -> *Authentication* and choose -> reCAPTCHA.
+To activate and **configure reCAPTCHA** for OpenProject, navigate to *Administration* -> *Authentication* and choose -> reCAPTCHA.
 
  If enabled, a captcha form will be rendered upon login for all users that have not verified a captcha yet. Please see the following link for more details on reCAPTCHA and their versions, and how to create the website and secret keys: [https://www.google.com/recaptcha](https://www.google.com/recaptcha).
 
@@ -16,6 +16,6 @@ You can configure the following options:
 1. Activate reCAPTCHA for OpenProject. You can choose between reCAPTCHA v2 and reCAPTCHA v3.
 2. Insert the **website key**.
 3. Insert the **secret key**.
-4. Press the blue **Apply** button to save your changes.
+4. Press the **Apply** button to save your changes.
 
 ![Sysadmin authentication reCAPTCHA](Sys-admin-authentication-recaptcha.png)

docs/system-admin-guide/authentication/two-factor-authentication/README.md

@@ -9,13 +9,13 @@ keywords: two-factor authentication
 
 ## Basic 2FA using TOTP
 
-To activate and **configure two-factor authentication** for OpenProject, navigate to -> *Administration* -> *Authentication* and choose -> *two-factor authentication*.
+To activate and **configure two-factor authentication** for OpenProject, navigate to *Administration* -> *Authentication* and choose -> *two-factor authentication*.
 
 From the GUI you are able to configure the following options:
 
 1. **Enforce 2FA** (two-factor authentication) for every user. All users will be forced to [register a 2FA device](../../../getting-started/my-account/#two-factor-authentication) on their next login.
 2. **Remember 2FA login** for a given number of days, e.g. 30 days.
-3. Press the blue **Apply** button to save your changes.
+3. Press the **Apply** button to save your changes.
 
 ![Sys-admin-authentication-two-factor-authentication](Sys-admin-authentication-two-factor-authentication.png)
 

docs/system-admin-guide/backlogs/README.md

@@ -9,7 +9,7 @@ keywords: configure backlogs, backlogs settings
 
 Configure your backlogs settings in OpenProject.
 
-Navigate to *Administration* -> *Backlogs* -> *Settings* to set up your backlogs.
+Navigate to *Administration* -> *Backlogs* to set up your backlogs.
 
 You can configure the following in the backlogs settings:
 
@@ -18,26 +18,6 @@ You can configure the following in the backlogs settings:
    Please note: You can't use a work package type as story type *and* as task type.
 3. Define to show **burn-down** or **burn-up** **chart**.
 4. Set a template for **sprint wiki page**. If you create a wiki page with this name, e.g. sprintwiki, you will set up a new wiki page based on this template if you open it via the sprint drop-down menu in the backlogs view. This way, you can easily create templates for sprint review meetings or retrospectives.
-5. Press the blue **apply** button to save your changes.
+5. Press the **Apply** button to save your changes.
 
-![backlogs-settings-system-admin-guide](image-20210305095740245.png)
-
-## Configure story cards to export
-
-Some Scrum teams also want to export their story cards to put them on a physical board. You can export your story cards and set a certain format for this export.
-
-Navigate to *Administration* -> *Backlogs* -> *Export Card Configs* in order to set a new story card configuration.
-
-Press the green **+ Export Card Config** button to create a new story card export configuration.
-
-![export story cards configuration](image-20200211153632946.png)
-
-1. Give a **name** for your story card export configuration.
-2. You can add a **description**.
-3. Define how many work packages (as defined as story types in the above settings, e.g. user stories) should be **printed per page**.
-4. Set the **page size**.
-5. Choose **landscape** or **portrait** for printing option.
-6. **Set rows configuration**. See the help icon with the question mark for further information regarding the row formatting.
-7. Press the blue **Create** button to save your changes.
-
-![Sys-admin-backlogs-export-story-card-config](Sys-admin-backlogs-export-story-card-config.png)
+![Backlog settings in OpenProject administration](openproject_system_admin_guide_backlog_settings.png)

docs/system-admin-guide/backup/README.md

@@ -1,7 +1,7 @@
 ---
 sidebar_navigation:
   title: Backup
-  priority: 790
+  priority: 200
 description: Backing up OpenProject.
 keywords: system backup
 ---