Fixes #1181 - Improve admin docs in various places#1183
Merged
Conversation
6 tasks
ArtifactsProduced during runtime |
There was a problem hiding this comment.
Pull request overview
This PR improves and standardizes large parts of the Zammad admin documentation, mainly by updating wording, permissions references, UI terminology, button formatting, and several renamed/restructured pages.
Changes:
- Adds or clarifies required admin permissions across many configuration pages.
- Standardizes UI wording such as “admin settings”, button labels, and list formatting.
- Renames/reworks some management reference pages and updates related toctrees/links.
Reviewed changes
Copilot reviewed 134 out of 150 changed files in this pull request and generated 14 comments.
Show a summary per file
| File | Description |
|---|---|
ai/ai-agents.rst |
Updates button formatting. |
ai/provider.rst |
Corrects GitHub capitalization. |
ai/writing-assistant.rst |
Updates button formatting. |
channels/chat.rst |
Reworks chat channel introduction and setup wording. |
channels/email/accounts/account-setup.rst |
Updates list and option formatting. |
channels/email/accounts/managing-accounts.rst |
Updates button formatting. |
channels/email/advanced/sendmail.rst |
Updates button formatting. |
channels/email/email-headers.rst |
Updates list formatting. |
channels/email/filters.rst |
Updates button formatting. |
channels/email/index.rst |
Updates list formatting. |
channels/facebook.rst |
Reworks Facebook channel setup wording and permissions context. |
channels/form.rst |
Substantially rewrites form channel documentation. |
channels/google/basic-setup.rst |
Updates Google OAuth setup wording and button formatting. |
channels/google/index.rst |
Updates list formatting. |
channels/microsoft365-graph/accounts.rst |
Updates Microsoft Graph setup wording and button formatting. |
channels/microsoft365/accounts/account-setup.rst |
Updates list and button formatting. |
channels/microsoft365/accounts/register-app.rst |
Updates app registration steps and formatting. |
channels/sms.rst |
Reworks SMS channel description and setup wording. |
channels/telegram.rst |
Reworks Telegram channel introduction and setup wording. |
channels/web.rst |
Rewrites web channel settings documentation. |
channels/whatsapp/index.rst |
Adds permission requirement for WhatsApp channel. |
channels/whatsapp/preparation.rst |
Updates Meta setup button formatting. |
channels/whatsapp/setup.rst |
Updates WhatsApp setup button formatting. |
includes/m365-imap-graph.rst |
Fixes orphan directive typo. |
index.rst |
Normalizes toctree indentation. |
manage/calendars.rst |
Updates button formatting. |
manage/checklist.rst |
Reworks checklist settings documentation. |
manage/groups/group-permissions.rst |
Renames/rewords group access documentation. |
manage/groups/index.rst |
Updates group permissions page reference. |
manage/groups/settings.rst |
Updates group settings wording and list formatting. |
manage/knowledge-base.rst |
Reworks knowledge base setup and permissions wording. |
manage/macros.rst |
Reworks macro introduction and permissions wording. |
manage/macros/how-do-they-work.rst |
Updates list formatting. |
manage/organizations/index.rst |
Updates organization management overview and links. |
manage/organizations/via-admin-settings.rst |
Rewords organization admin settings page. |
manage/organizations/via-csv-import.rst |
Updates CSV import formatting. |
manage/overviews.rst |
Reworks overview management introduction. |
manage/public-links.rst |
Adds permission context and updates wording. |
manage/report-profiles.rst |
Updates warning and action wording. |
manage/roles/index.rst |
Adds permission context and updates links. |
manage/roles/permissions.rst |
Updates group permissions links. |
manage/scheduler.rst |
Adds scheduler permission requirement. |
manage/slas.rst |
Updates button formatting. |
manage/tags.rst |
Expands tag management documentation. |
manage/templates.rst |
Adds permission context and rewords intro. |
manage/text-modules.rst |
Reworks text module wording and figure metadata. |
manage/time-accounting.rst |
Reworks time accounting documentation structure. |
manage/trigger.rst |
Reworks trigger title and permission wording. |
manage/trigger/how-do-they-work.rst |
Updates list formatting. |
manage/trigger/limitations.rst |
Fixes duplicate article typo. |
manage/trigger/system-notifications.rst |
Updates list formatting. |
manage/users/index.rst |
Reworks user management overview and links. |
manage/users/via-admin-settings.rst |
Adds new admin settings user management page. |
manage/users/via-csv-import.rst |
Reworks CSV import wording. |
manage/users/via-the-admin-panel.rst |
Removes old user admin panel page. |
manage/webhook.rst |
Adds webhook permission requirement. |
manage/webhook/add.rst |
Updates button formatting. |
manage/webhook/examples/add-checklist-to-ticket.rst |
Fixes typo in conditions label. |
manage/webhook/examples/generic-notifications-trigger.rst |
Updates button formatting. |
manage/webhook/examples/mattermost-notifications.rst |
Updates button formatting and alt text. |
manage/webhook/examples/microsoft-teams-notifications.rst |
Updates button and endpoint wording. |
manage/webhook/examples/ntfy-notifications.rst |
Updates button and payload wording. |
manage/webhook/examples/rocket-chat-notifications.rst |
Updates button formatting. |
manage/webhook/examples/slack-notifications.rst |
Updates button formatting. |
manage/webhook/payload.rst |
Updates webhook payload note list formatting. |
misc/first-steps.rst |
Reworks first steps wording and button formatting. |
misc/object-conditions/basics.rst |
Updates list and operator formatting. |
misc/object-conditions/expert-mode.rst |
Reworks expert mode wording. |
misc/variables.rst |
Updates variable usage wording. |
misc/variables/current-user.rst |
Removes extra blank line. |
misc/zabbix.rst |
Reworks Zabbix webhook setup wording. |
settings/branding.rst |
Adds permission context and updates formatting. |
settings/security.rst |
Adds security permission context. |
settings/security/base.rst |
Reworks security base settings wording. |
settings/security/password.rst |
Reworks password policy documentation. |
settings/security/ssl-certificates.rst |
Reworks SSL certificates documentation. |
settings/security/third-party.rst |
Reworks third-party authentication intro. |
settings/security/third-party/gitlab.rst |
Corrects GitLab capitalization. |
settings/security/third-party/google.rst |
Updates button formatting. |
settings/security/third-party/microsoft.rst |
Updates list formatting and typo. |
settings/security/third-party/openid-connect.rst |
Updates list formatting. |
settings/security/third-party/saml.rst |
Updates list formatting and wording. |
settings/security/third-party/saml/saml-keycloak.rst |
Updates Keycloak setup wording. |
settings/security/two-factor.rst |
Updates 2FA management wording. |
settings/system/base.rst |
Inlines base system setting notes. |
settings/system/frontend.rst |
Updates frontend setting wording. |
settings/system/index.rst |
Adds system permission context and SaaS note. |
settings/system/network.rst |
Removes self-hosted include. |
settings/system/services.rst |
Inlines service access notes. |
settings/system/services.include.rst |
Removes obsolete include. |
settings/system/storage.rst |
Removes self-hosted include and updates formatting. |
settings/system/system-base.include.rst |
Removes obsolete include. |
settings/system/system-selfhosted.include.rst |
Removes obsolete include. |
settings/ticket.rst |
Adds permission context and updates ticket settings wording. |
system/core-workflows.rst |
Reworks core workflow intro. |
system/core-workflows/how-do-they-work.rst |
Updates action/operator formatting. |
system/core-workflows/learn-by-example.rst |
Updates examples formatting. |
system/core-workflows/limitations.rst |
Updates list formatting. |
system/data-privacy.rst |
Updates button formatting. |
system/integrations/checkmk/admin-settings.rst |
Adds renamed Checkmk settings reference page. |
system/integrations/checkmk/api-reference.rst |
Updates list formatting and sidebar terminology. |
system/integrations/checkmk/index.rst |
Updates Checkmk intro and toctree entry. |
system/integrations/checkmk/setup-guide.rst |
Updates Checkmk setup wording. |
system/integrations/clearbit.rst |
Updates Clearbit setup wording. |
system/integrations/cti/generic.rst |
Updates list formatting. |
system/integrations/cti/includes/introduction.include.rst |
Reworks CTI introduction. |
system/integrations/cti/includes/outbound-calls.include.rst |
Updates list formatting. |
system/integrations/cti/includes/records-caller-log.include.rst |
Updates list and warning title formatting. |
system/integrations/cti/placetel.rst |
Updates requirements list formatting. |
system/integrations/cti/provider-configurations/sipgate.rst |
Updates list formatting. |
system/integrations/cti/sipgate.rst |
Updates requirements list formatting. |
system/integrations/elasticsearch.rst |
Reworks SaaS Elasticsearch limitations wording. |
system/integrations/exchange.rst |
Reworks Exchange setup headings and button formatting. |
system/integrations/github.rst |
Updates GitHub integration wording. |
system/integrations/gitlab.rst |
Updates GitLab integration wording. |
system/integrations/i-doit.rst |
Updates sidebar/admin settings terminology. |
system/integrations/index.rst |
Adds integration permission requirement and moves hint. |
system/integrations/ldap/index.rst |
Updates LDAP list and button formatting. |
system/integrations/pgp/index.rst |
Reworks PGP intro and formatting. |
system/integrations/smime/index.rst |
Reworks S/MIME intro and button formatting. |
system/integrations/smime/manage-certificates.rst |
Updates admin settings wording. |
system/integrations/smime/prerequisites.rst |
Updates list formatting and typos. |
system/integrations/smime/troubleshooting.rst |
Updates troubleshooting list formatting. |
system/maintenance.rst |
Updates button formatting and fixes figure path. |
system/monitoring.rst |
Reworks monitoring wording and formatting. |
system/objects.rst |
Updates object/state/priority UI wording. |
system/objects/external-data-source-example.rst |
Updates field/button formatting. |
system/objects/permissions.rst |
Reworks attribute permissions introduction. |
system/objects/types.rst |
Updates list and field formatting. |
system/packages.rst |
Fixes package management wording. |
system/sessions.rst |
Fixes duplicate word and updates formatting. |
system/subscription.rst |
Updates subscription button/plan formatting. |
system/system-report.rst |
Updates button formatting. |
system/translations.rst |
Reworks translation documentation wording and formatting. |
system/version.rst |
Rewords version page description. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.