[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-commits
Subject: [websites/hig-kde-org] source: updated contribute, changed spinx to optional
From: Fabian Riethmayer <null () kde ! org>
Date: 2018-02-28 20:50:55
Message-ID: E1er8gh-00047z-EZ () code ! kde ! org
[Download RAW message or body]
Git commit c2d237c681c13a9fd8505fa231471c6c0c3a7222 by Fabian Riethmayer.
Committed on 28/02/2018 at 20:50.
Pushed by fabianr into branch 'master'.
updated contribute, changed spinx to optional
Summary: Changed the contribute page, to make clearer that onecan contribute without installing Sphinx
Reviewers: romangg, colomar
Reviewed By: romangg
Tags: #kde_human_interface_guidelines
Maniphest Tasks: T8037
Differential Revision: https://phabricator.kde.org/D10727
M +27 -1 source/resources/contribute.rst
M +3 -1 source/style/typography.rst
https://commits.kde.org/websites/hig-kde-org/c2d237c681c13a9fd8505fa231471c6c0c3a7222
diff --git a/source/resources/contribute.rst b/source/resources/contribute.rst
index 3917f12..3513972 100644
--- a/source/resources/contribute.rst
+++ b/source/resources/contribute.rst
@@ -1,12 +1,38 @@
Contribute
==========
-The HIG source code is managed using Git and is hosted on https://cgit.kde.org/websites/hig-kde-org.git/ \
. `Sphinx <http://www.sphinx-doc.org>`_ is used to create HTML pages from the source files. `Phabricator \
<https://phabricator.kde.org/project/profile/264/>`_ is used to organize tasks and todos. +The HIG is \
written in `reStructuredText <http://www.sphinx-doc.org/en/stable/rest.html>`_, a lightweight markup \
language. +For example the chapter heading together with the first paragraph looks like this in \
reStructuredText:: +
+ Contribute
+ ==========
+
+ The HIG is written in `reStructuredText <http://www.sphinx-doc.org/en/stable/rest.html>`_, a light \
weight markup language. + For example the chapter heading together with the first paragraph look in \
reStructuredText like this +
+The restructuredText of the full HIG is organized into several source files. You can view and modify \
these source files with any text editor. +
+The source files are hosted in a `Git repo <https://cgit.kde.org/websites/hig-kde-org.git/>`_. `Sphinx \
<http://www.sphinx-doc.org>`_ is used to generate HTML pages from these source files. Tasks and changes \
are organized via `Phabricator <https://phabricator.kde.org/project/profile/264/>`_. +
+.. note:: On every page of the HIG, there is a *View page source* link in the top right corner.
If you are new to KDE devlopment, make sure to read `how to become a kde developer \
<https://community.kde.org/Get_Involved/development>`_ first.
Getting started
---------------
+#. Install git with your distro's package manager
+
+ * openSuse ``sudo zypper in git``
+ * Debian/Ubuntu/KDE Neon ``sudo apt install git``
+
+#. Clone HIG repositories into an empty folder
+ ``git clone https://anongit.kde.org/websites/hig-kde-org.git``
+
+Now you are ready to contribute to the HIG!
+
+Spinx
+^^^^^
+You only need to install Sphinx, if you want to preview changes on your local machine.
#. Install Spinx with your distro's package manager
diff --git a/source/style/typography.rst b/source/style/typography.rst
index 7d87aa2..023276e 100644
--- a/source/style/typography.rst
+++ b/source/style/typography.rst
@@ -11,7 +11,9 @@ A selection of typeface styles are allocated throughout the user interface as fo
.. image:: /img/Typography-noto.png
-* ''Note'' - For developers, it is recommended to use the system fonts available via \
''QFontDatabase::systemFont''. +.. hint::
+ |devicon| It is recommended to use the system fonts available via ''QFontDatabase::systemFont''.
+
* A monospace version of the ''Content Body 1'' typeface should be used for code content.
* Typography is treated like any other visual element when considering \
[[KDE_Visual_Design_Group/HIG/Placement|spacing]] and [[KDE_Visual_Design_Group/HIG/Alignment| \
alignment]].
* Limit the number of typeface style variations to about three in any single design.
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic