Skip to content

Commit

Permalink
Cleanup, page archival & redirect, above the fold adjustments (#7660)
Browse files Browse the repository at this point in the history
* Cleanup, page archival & redirect, above the fold adjustments

* Update source/conf.py
  • Loading branch information
cwarnermm authored Dec 16, 2024
1 parent b790d86 commit 14d6654
Show file tree
Hide file tree
Showing 15 changed files with 31 additions and 100 deletions.
2 changes: 1 addition & 1 deletion source/about/certifications-and-compliance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ What information is shared when I select **Contact us** on a Mattermost Admin Ad
Selecting **Contact us** in the Mattermost Admin Advisor will send some information to us. This may include the email address and name associated with your Mattermost account as well as the number of registered users on your system, the site URL, and a Mattermost diagnostic server ID number. This information is used to contact you as requested and to help us better understand your needs.

.. note::
:ref:`Mattermost Admin Advisor notices are disabled <manage/in-product-notices:admin advisor notices>` in v5.35 and later.
:doc:`Mattermost Admin Advisor notices are disabled </manage/in-product-notices>` in v5.35 and later.

Are the server access logs containing IP addresses a GDPR compliance issue?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
2 changes: 0 additions & 2 deletions source/about/faq-mattermost-source-available-license.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
:orphan:

Mattermost Source Available License questions
=============================================

Expand Down
4 changes: 3 additions & 1 deletion source/about/frequently-asked-questions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@ Frequently asked questions (FAQ)
:maxdepth: 2
:hidden:

faq-general.rst
General questions <faq-general>
Community questions <faq-community>
Notifications questions <faq-notifications>
Video, audio, and screen sharing questions <faq-video-audio-screensharing>
Enterprise questions <faq-enterprise>
License questions <faq-license>
Mattermost source available iicense questions <faq-mattermost-source-available-license>
Integration questions <faq-integrations>
Use cases <faq-use-cases>
Product questions <faq-product>
Expand All @@ -27,6 +28,7 @@ The following pages will answer many of your frequently asked questions about Ma
* :doc:`Video, audio, and screen sharing questions <faq-video-audio-screensharing>` - What's available for video and audio calling and screen sharing?
* :doc:`Enterprise questions <faq-enterprise>` - Learn about Mattermost Enterprise Edition.
* :doc:`License questions <faq-license>` - Learn more about Mattermost licenses.
* :doc:`Mattermost source available iicense questions <faq-mattermost-source-available-license>` - Learn what the Mattermost source available license offers.
* :doc:`Integration questions <faq-integrations>` - Can messaging functionality be added to a propietary SaaS service?
* :doc:`Use cases <faq-use-cases>` - Learn how Mattermost supports various use cases.
* :doc:`Product questions <faq-product>` - Which features are available on different Mattermost clients?
Expand Down
2 changes: 1 addition & 1 deletion source/collaborate/collaborate-within-channels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Everyone who joins a Mattermost :doc:`workspace </guides/use-mattermost>` is aut
Channel sidebar
----------------

In the channel sidebar on the left, you'll find all of the the channels you're a member of as well as useful channel management tools. See the :doc:`channel types <>` to learn about the types of channels available, how they work, and how to identify them in the channel sidebar. Learn how to create channels by visiting the :doc:`create channels </collaborate/create-channels>` documentation.
In the channel sidebar on the left, you'll find all of the the channels you're a member of as well as useful channel management tools. See the :doc:`channel types </collaborate/channel-types>` to learn about the types of channels available, how they work, and how to identify them in the channel sidebar. Learn how to create channels by visiting the :doc:`create channels </collaborate/create-channels>` documentation.

As your channel sidebar fills up with channels you've joined, you can organize your channels into categories based on how you work. See the :doc:`customize your channel sidebar </preferences/customize-your-channel-sidebar>` documentation for details.

Expand Down
5 changes: 1 addition & 4 deletions source/collaborate/keyboard-accessibility.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,7 @@ Keyboard accessibility
.. include:: ../_static/badges/allplans-cloud-selfhosted.rst
:start-after: :nosearch:

Navigational keyboard shortcuts help you use Mattermost in a web browser or the desktop app without needing a mouse. Below is a list of supported accessibility shortcuts. Elements in focus have a colored outline, as shown here:

.. image:: ../images/focus.png
:alt: Navigate Mattermost using a keyboard.
Navigational keyboard shortcuts help you use Mattermost in a web browser or the desktop app without needing a mouse. Below is a list of supported accessibility shortcuts.

+----------------------------------------------+----------------------------------------------------------------------------------+
| Keyboard shortcut | Description |
Expand Down
6 changes: 4 additions & 2 deletions source/collaborate/mark-channels-unread.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ Mark messages as unread
.. include:: ../_static/badges/allplans-cloud-selfhosted.rst
:start-after: :nosearch:

If you read a messages in a channel, but don't have time to address them right away, you can mark that channel as unread. Hover over the channel name in the channel sidebar, select the **More** |more-icon-vertical| option, then select **Mark as Unread**.
If you read messages in a channel, but don't have time to address them right away, you can mark that channel as unread. Hover over the channel name in the channel sidebar, select the **More** |more-icon-vertical| option, then select **Mark as Unread**.

.. image:: ../images/channel-more.png
:alt: When you hover over channels in the channel sidebar, you can access more message options from the More icon.

Marking a channel as unread displays the channel as bold in the channel sidebar, and marks all messages in the channel as unread messages.
.. tip::

Marking messages as unread displays those channels as bold in the channel sidebar.
3 changes: 2 additions & 1 deletion source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -1969,6 +1969,8 @@ def setup(_: Sphinx):
"https://docs.mattermost.com/collaborate/access-your-workspace.html",
"deploy/configure-app-framework.html":
"https://developers.mattermost.com/integrate/plugins/",
"deploy/high-scale-troubleshoot.html":
"https://docs.mattermost.com/install/troubleshooting.html#deployment-troubleshooting",

# Deployment redirects
"deployment/advanced-permissions.html":
Expand Down Expand Up @@ -2503,7 +2505,6 @@ def setup(_: Sphinx):
"https://docs.mattermost.com/install/install-tar.html",
"install/install-centos-oracle-scientific":
"https://docs.mattermost.com/install/install-rhel.html",

"install/install-common-intro.html":
"https://docs.mattermost.com/install/install-tar.html",
"install/install-latest-tarball.html":
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -559,7 +559,7 @@ Remove members
:alt: Remove a member from the channel using the System Console.

Archive a channel
~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~

1. Go to **System Console > User Management > Channels** to access all available channels.
2. Select the channel from the list to view its configuration page.
Expand Down
24 changes: 0 additions & 24 deletions source/deploy/high-scale-troubleshoot.rst

This file was deleted.

2 changes: 0 additions & 2 deletions source/guides/deployment-troubleshooting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,13 @@ Deployment troubleshooting
:titlesonly:

General troubleshooting </install/troubleshooting>
Troubleshooting your high scale deployment </deploy/high-scale-troubleshoot>
Troubleshooting mobile applications </deploy/mobile-troubleshoot>
PostgreSQL installation troubleshooting </install/trouble-postgres>
MySQL installation troubleshooting </install/trouble_mysql>

These guides will help you troubleshoot aspects of your Mattermost deployment.

* :doc:`General deployment troubleshooting </install/troubleshooting>`
* :doc:`High scale troubleshooting </deploy/high-scale-troubleshoot>`
* :doc:`Mobile applications troubleshooting </deploy/mobile-troubleshoot>`
* :doc:`PostgreSQL installation troubleshooting </install/trouble-postgres>`
* :doc:`MySQL installation troubleshooting </install/trouble_mysql>`
2 changes: 1 addition & 1 deletion source/guides/deployment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Learn how to install, deploy, and scale Mattermost for teams and organizations o

* See the :doc:`configuration settings </configure/configuration-settings>` documentation to learn more about customizing your production deployment.

* Encountering issues with your deployment? See the :ref:`Deployment Troubleshooting <install/troubleshooting:deployment troubleshooting>` or :doc:`high scale troubleshooting </deploy/high-scale-troubleshoot>` documentation for details.
* Encountering issues with your deployment? See the :ref:`Deployment Troubleshooting <install/troubleshooting:deployment troubleshooting>` documentation for details.

* :doc:`Migrate from MySQL to PostgreSQL </deploy/postgres-migration>` - Learn how to migrate from MySQL to PostgreSQL.
* :doc:`Prepare your Mattermost database </install/prepare-mattermost-database>` - Learn how to prepare and configure a database for Mattermost.
Expand Down
Binary file modified source/images/announcement-banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion source/install/install-kubernetes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Running Mattermost in Kubernetes requires resources based on your total number o
- If you’re unsure about which environment you want to use for your Kubernetes cluster, we suggest using a managed service such as as `Amazon EKS <https://aws.amazon.com/eks/>`_, `Azure Kubernetes Service <https://azure.microsoft.com/en-ca/products/kubernetes-service/>`_, `Google Kubernetes Engine <https://cloud.google.com/kubernetes-engine/>`_, or `DigitalOcean Kubernetes <https://www.digitalocean.com/products/kubernetes/>`_.
- Looking for a quick way to evaluate Mattermost or to try out the latest Mattermost deployment? Learn how to `create your own Mattermost instance on Kubernetes using Minicube <https://medium.com/@Erez.Tamam/create-your-own-mattermost-instance-on-kubernetes-in-10-minutes-d13f576ed794>`_.
- See the :doc:`configuration settings </configure/configuration-settings>` documentation to learn more about customizing your production Mattermost deployment.
- Encountering issues with your deployment? See the :ref:`deployment troubleshooting <install/troubleshooting:deployment troubleshooting>` or :doc:`high scale troubleshooting </deploy/high-scale-troubleshoot>` documentation for details.
- Encountering issues with your deployment? See the :ref:`deployment troubleshooting <install/troubleshooting:deployment troubleshooting>` documentation for details.

Install Mattermost on Kubernetes
--------------------------------
Expand Down
47 changes: 9 additions & 38 deletions source/manage/in-product-notices.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,64 +14,35 @@ Administrator notices inform system admins when a new server version is availabl
.. image:: ../images/notices_admin.png
:alt: An example of an in-product administrator notice announcing that a new server version of Mattermost is available. Admin notices can be disabled.

System admins can disable end user notices by going to the **System Console > Site Configuration > Notices** page.
System admins can disable end user notices by going to **System Console > Site Configuration > Notices**.

End user notices
----------------

End user notices are used to inform all users when:

- new desktop app versions and feature enhancements are available.
- New desktop app versions and feature enhancements are available for users.
- Mattermost is gathering user feedback to improve the product and user experience.

System admins can disable end user notices by going to the **System Console > Site Configuration > Notices** page.
System admins can disable end user notices by going to **System Console > Site Configuration > Notices**.

.. image:: ../images/notices.png
:alt: An example of an end user in-product notice announcing that a new Mattermost desktop app release is available. End user notices can be disabled.

Frequently asked questions (FAQs)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
----------------------------------

Are notices enabled by default?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Notices are enabled by default for all Mattermost users. System admins may choose to disable administrator or end user notices in **System Console > Site Configuration > Notices**.
Yes. Notices are enabled by default for all Mattermost users. System admins may choose to disable admin or end user notices in **System Console > Site Configuration > Notices**.

Will I still receive notices if my server is air-gapped?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

No, the Mattermost server requires a connection to the internet to receive notices.

How often will users receive notices?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Notices will be used to raise awareness of new features as part of our monthly release cadence. Users will only receive notices that specifically apply to them. For example, if a user is already running the latest Desktop App version, they will not receive an upgrade notice.

Admin Advisor notices
---------------------

Admin Advisor notices are designed to provide guidance and assist in choosing features to support your deployment as it scales.

.. note::
Admin Advisor notices are disabled.

When these notices are triggered, system admins receive a bot message notification and, for larger instances, a dismissable daily banner with quick access to contact support. The notices are triggered based on usage such as the number of registered users, posts, or channels in your deployment reaching a predefined threshold.

.. image:: ../images/mattermost_admin_advisor_banner.png
:alt: An example of an Admin Advisor notice. Admin Advisor notices provide guidance as your deployment scales in size. Admin Advisor notices are disabled.

.. image:: ../images/mattermost_admin_advisor_bot.png
:alt: An example of an Admin Advisor notice that includes an option for system admins to contact Mattermost Support. Admin Advisor notices are disabled.

Commercial customers can `contact our support team <https://mattermost.com/support/>`_ for additional assistance. There are also links on the Support site to useful resources for user management and provisioning to support large systems.

Managing Admin Advisor notices
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The Admin Advisor notices are run on a schedule based on specific triggers.

- Selecting **Contact us** in the Admin Advisor banner dismisses the banner notification. In addition, contact information, such as the email address and name associated with your Mattermost account, is sent to us so we can contact you as requested and help us better understand your needs. The number of registered users on your system, the site URL, and a Mattermost diagnostic server ID number are also sent to us to better understand your environment and hence provide more tailored support.
- Selecting **Acknowledge** in the Admin Advisor banner closes the advisory and does not send your details to Mattermost.
- Closing the notification bot removes the conversation from your Direct Messages list.

We welcome your feedback on this feature. Please visit `our forum <https://forum.mattermost.com/t/new-admin-advisor-notifications-in-mattermost-v5-26/10263/6>`_ if you have any questions or feedback.
Notices will be used to raise awareness of new features as part of our monthly release cadence. Users will only receive notices that specifically apply to them. For example, if a user is already running the latest Desktop App version, they will not receive an upgrade notice.
Loading

0 comments on commit 14d6654

Please sign in to comment.