From 1e607fe0a56d78c40cd590c01819d02bc4ad0c45 Mon Sep 17 00:00:00 2001 From: Sybille Peters Date: Wed, 15 Jan 2025 09:46:45 +0100 Subject: [PATCH] Remove page "Resources for Editors" This page was initially introduced to provide some information and conventions for people editing this guide. However, the page is only valualbe, if visible and commonly used. Unless a general convention is established if and how to provide information about editing a specific guide, the page is of little value and should be removed. Related: #255 --- Documentation/Appendix/Index.rst | 1 - .../Appendix/ResourcesForEditors/Index.rst | 49 ------------------- 2 files changed, 50 deletions(-) delete mode 100644 Documentation/Appendix/ResourcesForEditors/Index.rst diff --git a/Documentation/Appendix/Index.rst b/Documentation/Appendix/Index.rst index d6b9b96d..71bee22d 100644 --- a/Documentation/Appendix/Index.rst +++ b/Documentation/Appendix/Index.rst @@ -17,4 +17,3 @@ in more depth than what is already described in the main section. Windows/Index Linux/Index * - ResourcesForEditors/Index diff --git a/Documentation/Appendix/ResourcesForEditors/Index.rst b/Documentation/Appendix/ResourcesForEditors/Index.rst deleted file mode 100644 index 4aa3c821..00000000 --- a/Documentation/Appendix/ResourcesForEditors/Index.rst +++ /dev/null @@ -1,49 +0,0 @@ -.. include:: /Includes.rst.txt - -.. _resources-for-editors: - -================================== -Information for editing this guide -================================== - -Here, we list some resources that are useful when editing this manual: - -General information -=================== - -* :ref:`h2document:start` (official guide) - -Resources for this guide -======================== - -* `Issues on Github `__ - -Best practices for editing this guide -===================================== - -Images ------- - -Example: :ref:`GerritAccount` - -Hints for creating images -~~~~~~~~~~~~~~~~~~~~~~~~~ - -Do not create huge fullscreen images. If an image contains too much information, -try to highlight the significant information by using boxes, text, numbers and / or -arrows in the image. - -Add a white border inside the image if it helps the image to stand out from the text. - -Hints for adding images -~~~~~~~~~~~~~~~~~~~~~~~ - -When adding images, always set a shadow in rest: - -.. code-block:: rst - - .. image:: /Images/External/Tower/gerrit-new-ui2.png - :class: with-shadow - -If it helps with readability on screen, limit the size of the image. -