pull1 - #1
Open
sstidl wants to merge 181 commits into
Open
Conversation
The Site URL on Gitlab config on Zammad use the schema "https://git_host/api/v4/"
clearify that scheduler uses only UTC timezone
* Update gitlab.rst The Site URL on Gitlab config on Zammad use the schema "https://git_host/api/v4/" * removing obsolete picture * updating image to image with correct site URL * Correction of image URL + adjustment of text Many thanks to: https://github.com/cyberrranger
* adding information about group-dependent text modules This introduces our new group-dependent text modules. Besides, I removed a wrong text part that claimed that text modules would be available within Triggers (they are not). * Added performance hint for overviews This will satisfy issue #19 * Enhance overview of overview-documentation During by enhancement trip I thought that the overview of this page wasn't that good. This commit tries to solve this. It also fixes strange picture usuage which might lead to confusion. Corrected a small mistake that stated all users could change overview settings, while only agents can do so globally.
Commit / fix originally by: https://github.com/Jaykju (Thank you very much!) * Fix generic-cti.rst spelling error In line 44 it should be CTI API intro
This commit updates reporting profile related screenshots to meet our requirenments and to remove the screenshotted display error. This will solve issue #32
Add article for mail account setup with Google 2FA
* adding information about group-dependent text modules This introduces our new group-dependent text modules. Besides, I removed a wrong text part that claimed that text modules would be available within Triggers (they are not). * Added performance hint for overviews This will satisfy issue #19 * Enhance overview of overview-documentation During by enhancement trip I thought that the overview of this page wasn't that good. This commit tries to solve this. It also fixes strange picture usuage which might lead to confusion. Corrected a small mistake that stated all users could change overview settings, while only agents can do so globally. * add saml docs * add saml docs image * WIP: Usuage of Macros * adding saml documentation to security-settings page Other wise we won't find the SAML docs :) * heading marker adjustments * optical adjustments * update Readme with protected branch note Simply a small hint on the branches and what would be the best way to create a PR :) * Rework of objects This is a slight rework of Zammads object docs. It also introduces the new link template, but still lacks some fancy phrases and maybe even a variable doc. * Initial system variable commit This commit introduces an initial pre-version of future system variable reference that can be referenced all over the docs. * added hints / references to system variables * update object detail view to show current function as well * Rework and finish for system objects This will satisfy Issue zammad/zammad#2103 . * finish ticket system-variables The variable list now contains sample data. * System variable values for config variables * added values for article variables * description text for ticket article variables * add Telegram hint for file sizes See issue: zammad/zammad#2289 * add hint for system variables to text modules As suggested my Johannas within #35 * WIP: Refactoring E-Mail channel structure * WIP: E-Mail-Settings This is going to address issu e #12 some day * WIP: E-Mail-Settings * E-Mail channel structual doc changes Mainly affects navigation to behave better * Finish E-Mail-Settings tab This will satisfy issue #12 * typo fixing for variable tables Tables where missing "s * cherrypick email-channel commit for 2FA gmail This commits ensures not to loose information on 2FA gmail. * small rework of signature documentation Mainly optical changes * Finish Settings in Ticket hint This helps to cover these fairly hidden settings and describes what they do/mean. * Rework ticket section This is mainly an optical rewrite, but also changes some wordings. * Add remark about technical size limitations of telegram messages * fix typo Link was broken * added values for current user variables This finishes the variable part of the documentation (yay) * Updated SAML docs to contain automatic linking reference This helps users to find the automatic account linking option easier. :-) * added missing picture for github authentication * corrected typo has stated by Johanna. :) * Replace :ref: with :doc: wherever possible ReStructuredText provides many ways to create internal links (i.e., cross-referencing specific locations throughout a project). The two most common ones are :doc: (for linking to a specific page) and :ref: (for linking to any arbitrary location). :ref: requires you to create a destination marker somewhere in the project, like so: .. foo:: so that it can be linked thusly: :ref:`foo` :doc:, on the other hand, simply takes the path of a page in the project, and requires no additional marker to be added anywhere: :doc:`/path/to/page` Prior to this commit, there were many :ref: links that simply pointed to the top of a target page. :doc: works just as well for this purpose, so this commit replaces all those instances of :ref: with :doc:. * QA E-Mail docs * Reorganize "Channels > Email" subtree * Create "Misc" TOC section for Composer Settings docs Originally, we had a docs page for "Settings in Tickets" which referred the ticket composer settings dialog. This page had no good place in the TOC (it was originally placed under the "Channels > Email" page), and the name was confusing (since we already have a "Settings > Ticket" page). This commit renames it to "Composer Settings" and places it under a new TOC section, "Misc". * Fix RST syntax errors At compile time (i.e., when running `make html`), the ReStructuredText compiler emits warnings for syntax errors: /zammad-admin-documentation/system-monitoring.rst:15: WARNING: Unexpected indentation. /zammad-admin-documentation/system-monitoring.rst:19: WARNING: Unexpected indentation. /zammad-admin-documentation/system-variables/config.rst:2: WARNING: Title underline too short. This commit fixes all such syntax errors, resulting in a clean compilation process. * Remove trailing whitespace from all files * Remove macOS .DS_Store metadata file from repo * Fix RST indentation Python convention (by which I mean the style guide for official Python language documentation) is to use three spaces for indentation in ReStructuredText files. This is not a strict requirement of RST syntax[0], but it produces a clean visual structure for RST's directive syntax: .. note:: Lorem ipsum dolor sit amet consectetur In the case of lists, however, two spaces look better: - Lorem ipsum dolor sit amet consectetur but in all other cases, we use three spaces for maximum consistency. This commit replaces all indentation according to the rules above. [0]: https://stackoverflow.com/questions/48311159 * Downcase all directives This commit was made purely for stylistic consistency. * Fix instances of hanging '::' This commit fixes RST syntax for certain `image::` directives. It was not strictly necessary, as the compiler doesn't raise an error in these cases, but was done for consistency within the codebase. * Replace 'E-Mail' with 'email' * Fix German-style hyphens and capitalization The existing docs contained many instances of German-style hyphens and capitalization. In English, capitalization is reserved for titles and proper nouns. Of course, in technical writing, sometimes it's appropriate to capitalize words that refer to elements on the screen, such as: > When you're finished writing your message, click "Submit". In these cases, the screen element ("Submit") should be emphasized with additional styling, such as quotation marks, italics, or boldfaced lettering. (I don't have a source for this, unfortunately, but I would argue that it's more than my personal opinion.) This commit doesn't add any such styling to these cases, but it does fix capitalization where appropriate. Hyphens are used sparingly, and the rules are confusing. "Auto-reply" is okay, but "API token" is not (because "API" is its own word, but "auto" is not). "Email-related" is also okay, because it forms one single adjective. * QA README * QA Telegram docs * QA references to system-variables page * QA SAML docs * QA Ticket Settings docs * QA System Variables docs * Reorganize directory structure to reflect TOC * Remove unused 'Roles' draft doc
Little typo.
Update variables.rst
Broken link at the bottom (copied the valid one at the top).
Text Module page holds a broken link to the user documentation at the button.
In some situations it's possible a user cannot activate 2 step verficiation for an account. This might be because he's missing the right to do so. This commit provides a hint that it needs to be active and where the G-Suite admin can find the setting.
…tion" In some situations it's possible a user cannot activate 2 step verficiation for an account. This might be because he's missing the right to do so. This commit provides a hint that it needs to be active and where the G-Suite admin can find the setting.
* initial rework This rework -for now- mainly contains structural changes and preparations. * adding toctree and links * finished wording on initial trigger page * change image to figure for better spacings on example page * Update trigger pictures This replaces old jpgs with pngs (as suggested by Ryan) and now uses a subfolder for better overview. * add hint for triggers within calendars As triggers now also can rely on calendars, I've added a small hint. * rework images on conditions and actions for triggers This meets the suggested pngs of ryan and also shows the current UI look and feel. * slight rework and addition Slightly reworked existing texts and added further things like execution time condition for triggers. * Enhance calendar wording for it's cope Accepting Ryans suggestion on enhance the messy wording on the calendar introduction. This will change it into a way better listing and clear the goal up a lot. Co-Authored-By: Ryan Lue <hello@ryanlue.com> * re arrange navigation structure and places where to find information As per internal discussion with ryan, as we were pushing rst capatilities a bit too far and thus ran into issues with navigation urls not fitting the toctree as we wanted to. For this we moved information to sub pages. * add introduction text The learn by example page jumped in directly. It now comes with an introduction text to help the reader better. * add postmaster filter als other alternative to triggers In limitations we're talking about possible issues you can't solve with triggers. Schedulers usually are the correct alternative here, however, in some situations a postmaster filter is a good choice as well. This is why we shouldn't leave it out. * Rename "other notifications" to "system notifications" As this was basically always about system notifications, this is an alot better wording. * Added limitations hint for the condition and actions page This helps to understand the user the scope and limitations of triggers better. * Flesh out and restructure Trigger intro page * Highlight important information with hint/note insets * Rename "Conditions and Actions" page for clarity * Rename Trigger subsection files to match their titles Co-authored-by: Ryan Lue <hello@ryanlue.com>
Based on PR #36 this commit adds hints on how to call Zammad console or commands on different installation types.
Co-authored-by: Ryan Lue <hello@ryanlue.com>
Explain where commands in code samples are platform-dependent.
This commit provides step-by-step directions for creating email channels. This can help administrators spot potential issues during configuration by providing a fine-grained view of each individual setting. Ideally, it will shed light on some of the more obscure parts of Zammad. Also, it explains how to configure outbound channels, which was originally missing from the docs. *whoops*
See this 2012 blog post by Brandon Rhodes[0] to learn more about semantic linebreaks. [0]: https://rhodesmill.org/brandon/2012/one-sentence-per-line/
This includes updating existing email accounts, disabling or even removing them.
This documentation page holds all information about email addresses and how to service them. This shall help administrators greatly, because right now this is more of a blackbox if you're starting. 💪
This holds all relevant information on how email notifications work, in which situations they are sent and of course how to the channel itself.
This rework improves screenshot quality, overall structure and covers user permission and core workflow better.
Extend S/MIME with by now available options
…response Introduce email header auto response page for triggers.
Updated jQuery version for Chat and Form widgets
Add Core Workflow documentation
Several small additions with Zammad 5.0
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
16 participants
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.