Changed the contribute page, to make clearer that onecan contribute without installing Sphinx
Details
Details
- Reviewers
romangg colomar - Maniphest Tasks
- T8037: Contribute: Sphinx not needed
- Commits
- R985:c2d237c681c1: updated contribute, changed spinx to optional
Diff Detail
Diff Detail
- Repository
- R985 KDE Human Interface Guidelines
- Branch
- master
- Lint
No Linters Available - Unit
No Unit Test Coverage
| source/resources/contribute.rst | ||
|---|---|---|
| 4–17 | Replace with: 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:: | |
| 11 | Replace with: The restructuredText of the full HIG is organized into several source files. You can view and modify these source files with any text editor. | |
| 13 | Put this note before the "Getting started" header below. | |
| 15 | Replace with: 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/>`_. | |
| 35 | ...preview changes on your local machine. | |
| source/resources/contribute.rst | ||
|---|---|---|
| 13 | Correction: put it before the "If you are new to KDE devlopment, make sure to read..." paragraph. | |
Comment Actions
- changes on the contribute page suggested by romangg
and a small bugfix on typhography
Comment Actions
light weight -> lightweight
look in reStructuredText like this -> looks like this in reStructured Text
| source/resources/contribute.rst | ||
|---|---|---|
| 19 | This is still an unnecessary barrier. If we need people to do all that stuff explained on that Wiki page just to contribute to the HIG, we've clearly done it wrong. This should go into a "further information" section, not in a "Do this before you contribute" area. | |
Comment Actions
I landed the patch, because I think it is an improvment to the current page, but will add a task to impove it even further as Colomar suggested.