Skip to content

Commit ef2d014

Browse files
committed
Set indents to 4 spaces. Wrap long lines.
1 parent da06225 commit ef2d014

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+2962
-2936
lines changed

Documentation/About.rst

Lines changed: 41 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
.. include:: /Includes.rst.txt
1+
.. include:: /Includes.rst.txt
22

3-
.. _about:
3+
.. _about:
44

55
================
66
About This Guide
@@ -19,22 +19,22 @@ Why contribute?
1919

2020
Here are some ideas why contribution is great:
2121

22-
* Do you earn your income through the TYPO3 ecosystem? Contribute to keep it alive and going,
23-
securing your work.
24-
* Do you want to become a more experience developer? Or gather UX/UI expertise in a
25-
large, broadly used system?
26-
* Do you work in a company that has less sophisticated code testing and review capacities,
27-
and you want to learn from the TYPO3, understand it, and use your
28-
knowledge to work more effectively?
29-
* Do you want to keep up to date with latest development, be a part of it to
30-
shape it suit your needs? Have a democratic impact on a large project affecting
31-
many people?
32-
* If you know about fresh changes, it will make it much easier to perform updates
33-
for your projects! If you spot breaking changes affecting your project,
34-
you can much better give feedback on it and shape the final implementation.
35-
* Get in touch with awesome, kind and dedicated like-minded people like you.
36-
Be part of a community and feel connected, and see people appreciating your
37-
help.
22+
* Do you earn your income through the TYPO3 ecosystem? Contribute to keep it alive and going,
23+
securing your work.
24+
* Do you want to become a more experience developer? Or gather UX/UI expertise in a
25+
large, broadly used system?
26+
* Do you work in a company that has less sophisticated code testing and review capacities,
27+
and you want to learn from the TYPO3, understand it, and use your
28+
knowledge to work more effectively?
29+
* Do you want to keep up to date with latest development, be a part of it to
30+
shape it suit your needs? Have a democratic impact on a large project affecting
31+
many people?
32+
* If you know about fresh changes, it will make it much easier to perform updates
33+
for your projects! If you spot breaking changes affecting your project,
34+
you can much better give feedback on it and shape the final implementation.
35+
* Get in touch with awesome, kind and dedicated like-minded people like you.
36+
Be part of a community and feel connected, and see people appreciating your
37+
help.
3838

3939
How this guide is structured
4040
============================
@@ -51,38 +51,36 @@ you are looking for or browse through the menu.
5151

5252
For example:
5353

54-
* :ref:`quickstart-create-a-patch` walks you through making a change in the TYPO3
55-
core (e.g. fix a bug or create a new feature).
54+
* :ref:`quickstart-create-a-patch` walks you through making a change in the TYPO3
55+
core (e.g. fix a bug or create a new feature).
5656

5757

5858
The chapters are structured as follows:
5959

60-
* The chapters in :guilabel:`INTRODUCTION` give you an introduction. They are not necessary
61-
for contribution but will give you some background information which may make
62-
some things easier.
63-
* The chapters in :guilabel:`SETUP` show how to setup a TYPO3 installation, Git and your
64-
accounts for contribution. This is a necessary prerequisite for most actions
65-
(e.g. creating a patch), but must be done only once. We recommend to start with
66-
this.
67-
* The chapters in :guilabel:`HOWTOS` walk you through one task. In most cases, it is assumed
68-
that you already setup your environment.
69-
* :guilabel:`ADDITIONAL INFORMATION` contains a cheat sheet
70-
:ref:`git cheat sheet <cheat-sheet-git>`, :guilabel:`Troubleshooting`
71-
and the :ref:`appendix` which is a reference of some topics in more depth than what
72-
was described in the main section. These pages near the end of the manual assume
73-
that you are already familiar with contributing and serve as reference pages.
74-
75-
60+
* The chapters in :guilabel:`INTRODUCTION` give you an introduction. They are not necessary
61+
for contribution but will give you some background information which may make
62+
some things easier.
63+
* The chapters in :guilabel:`SETUP` show how to setup a TYPO3 installation, Git and your
64+
accounts for contribution. This is a necessary prerequisite for most actions
65+
(e.g. creating a patch), but must be done only once. We recommend to start with
66+
this.
67+
* The chapters in :guilabel:`HOWTOS` walk you through one task. In most cases, it is assumed
68+
that you already setup your environment.
69+
* :guilabel:`ADDITIONAL INFORMATION` contains a cheat sheet
70+
:ref:`git cheat sheet <cheat-sheet-git>`, :guilabel:`Troubleshooting`
71+
and the :ref:`appendix` which is a reference of some topics in more depth than what
72+
was described in the main section. These pages near the end of the manual assume
73+
that you are already familiar with contributing and serve as reference pages.
7674

7775
Conventions used in this guide
7876
==============================
7977

80-
* When referring to elements in the gui, we use this formatting:
81-
:guilabel:`Add new SSH key`.
82-
* Keystrokes are referred to by :kbd:`CTRL + c`
78+
* When referring to elements in the gui, we use this formatting:
79+
:guilabel:`Add new SSH key`.
80+
* Keystrokes are referred to by :kbd:`CTRL + c`
8381

8482

85-
.. _other-resources-for-contribution:
83+
.. _other-resources-for-contribution:
8684

8785
Other ways to contribute
8886
========================
@@ -91,10 +89,10 @@ Besides developing for the TYPO3 core, there are many other ways to contribute a
9189

9290
You can find general information here:
9391

94-
* General information about the various `Teams & Committees <https://typo3.org/community/teams/>`__
95-
* General information on how you can `Contribute and Get Involved <https://typo3.org/community/contribute/>`__
92+
* General information about the various `Teams & Committees <https://typo3.org/community/teams/>`__
93+
* General information on how you can `Contribute and Get Involved <https://typo3.org/community/contribute/>`__
9694

97-
.. _contribute:
95+
.. _contribute:
9896

9997
Contribute to this Guide
10098
========================
Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,60 @@
1-
.. include:: /Includes.rst.txt
1+
.. include:: /Includes.rst.txt
22

33

4-
.. index::
5-
single: Tools; Gerrit
6-
single: Account; Gerrit
4+
.. index::
5+
single: Tools; Gerrit
6+
single: Account; Gerrit
77

8-
.. _GerritAccount:
9-
.. _gerrit-ssh:
8+
.. _GerritAccount:
9+
.. _gerrit-ssh:
1010

1111
=======================
1212
Setting up Gerrit (ssh)
1313
=======================
1414

15-
.. rst-class:: bignums-xxl
15+
.. rst-class:: bignums-xxl
1616

17-
1. Click the :guilabel:`Sign In` button in the top right corner of the page
18-
`review.typo3.org <https://review.typo3.org>`__.
17+
1. Click the :guilabel:`Sign In` button in the top right corner of the page
18+
`review.typo3.org <https://review.typo3.org>`__.
1919

20-
.. image:: /Images/External/Gerrit/Account/gerrit_signin2.png
21-
:class: with-shadow
20+
.. image:: /Images/External/Gerrit/Account/gerrit_signin2.png
21+
:class: with-shadow
2222

23-
You will be prompted with a regular :guilabel:`Basic Authentication`
24-
window, simply enter your TYPO3.org username and password you had
25-
:ref:`set up earlier <TYPO3Account>`.
23+
You will be prompted with a regular :guilabel:`Basic Authentication`
24+
window, simply enter your TYPO3.org username and password you had
25+
:ref:`set up earlier <TYPO3Account>`.
2626

2727

28-
2. Create your SSH key
28+
2. Create your SSH key
2929

30-
If you don't know how to create your SSH Public/Private Key,
31-
we have compiled a list of links for you:
30+
If you don't know how to create your SSH Public/Private Key,
31+
we have compiled a list of links for you:
3232

33-
* :ref:`OS X <ssh-key-osx>`
34-
* :ref:`Microsoft Windows <ssh-key-win>`
35-
* :ref:`Linux/Unix <ssh-key-unix>`
33+
* :ref:`OS X <ssh-key-osx>`
34+
* :ref:`Microsoft Windows <ssh-key-win>`
35+
* :ref:`Linux/Unix <ssh-key-unix>`
3636

3737

38-
3. Add your public SSH key to Gerrit
38+
3. Add your public SSH key to Gerrit
3939

40-
.. image:: /Images/External/Gerrit/Account/gerrit-add-ssh-key2.png
41-
:class: with-shadow
40+
.. image:: /Images/External/Gerrit/Account/gerrit-add-ssh-key2.png
41+
:class: with-shadow
4242

43-
* Click on your profile in the top right corner and click :guilabel:`Settings`.
43+
* Click on your profile in the top right corner and click :guilabel:`Settings`.
4444

45-
* On the left hand side, click :guilabel:`SSH Keys`.
45+
* On the left hand side, click :guilabel:`SSH Keys`.
4646

47-
* Copy-paste the contents of your public SSH key file (e.g.
48-
:file:`~/.ssh/id_rsa.pub`) into the text field next to
49-
:guilabel:`New SSH key` and
50-
then click on :guilabel:`Add new SSH key`.
47+
* Copy-paste the contents of your public SSH key file (e.g.
48+
:file:`~/.ssh/id_rsa.pub`) into the text field next to
49+
:guilabel:`New SSH key` and
50+
then click on :guilabel:`Add new SSH key`.
5151

5252
If you work with different computers, for example with a notebook
5353
at work and another computer at home you can either copy your
5454
private key or create a separate key for the other computer. Luckily
5555
Gerrit can handle multiple keys.
5656

57-
.. important::
57+
.. important::
5858

59-
Always keep your keys private. Never give them away. No member of the
60-
TYPO3 project will ever ask you for your keys.
59+
Always keep your keys private. Never give them away. No member of the
60+
TYPO3 project will ever ask you for your keys.

Documentation/Account/Index.rst

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
1-
.. include:: /Includes.rst.txt
1+
.. include:: /Includes.rst.txt
22

33

4-
.. index::
5-
single: Account; Setup
6-
single: Account
4+
.. index::
5+
single: Account; Setup
6+
single: Account
77

8-
.. _TYPO3-Guide-ContributionWorkflow-Account:
9-
.. _setting-up-your-account:
8+
.. _TYPO3-Guide-ContributionWorkflow-Account:
9+
.. _setting-up-your-account:
1010

1111
========================
1212
Setting up Your Accounts
1313
========================
1414

1515
These are the TYPO3 online tools you will be using. For these you need a typo3.org account.
1616

17-
* **Forge**: our **Issue Tracker** based on Redmine
18-
* **Gerrit**: our **Code Review** System
19-
* **Slack**: which is used for general communication
20-
(not required, but strongly recommended)
17+
* **Forge**: our **Issue Tracker** based on Redmine
18+
* **Gerrit**: our **Code Review** System
19+
* **Slack**: which is used for general communication
20+
(not required, but strongly recommended)
2121

2222
Follow the instructions to setup your accounts:
2323

24-
* :ref:`TYPO3Account`
25-
* :ref:`GerritAccount`
26-
* optional: :ref:`slack-account`
24+
* :ref:`TYPO3Account`
25+
* :ref:`GerritAccount`
26+
* optional: :ref:`slack-account`
2727

28-
.. toctree::
29-
:maxdepth: 1
30-
:hidden:
28+
.. toctree::
29+
:maxdepth: 1
30+
:hidden:
3131

32-
TYPO3Account
33-
GerritAccount
34-
Slack
32+
TYPO3Account
33+
GerritAccount
34+
Slack

Documentation/Account/Slack.rst

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
.. include:: /Includes.rst.txt
1+
.. include:: /Includes.rst.txt
22

3-
.. _slack-account:
3+
.. _slack-account:
44

55
=====
66
Slack
@@ -13,59 +13,59 @@ it is the projects chosen platform for communication.
1313
It is mandatory to create a typo3.org account, before you
1414
can join the TYPO3 Slack workspace.
1515

16-
.. index::
17-
single: Account; Slack Registration
18-
single: Tools; Slack Registration
16+
.. index::
17+
single: Account; Slack Registration
18+
single: Tools; Slack Registration
1919

20-
.. _register-for-slack-account:
20+
.. _register-for-slack-account:
2121

2222
Register for Slack account
2323
--------------------------
2424

25-
.. rst-class:: bignums-xxl
25+
.. rst-class:: bignums-xxl
2626

27-
1. :ref:`Signup for typo3.org account <TYPO3Account>` (if not done already)
27+
1. :ref:`Signup for typo3.org account <TYPO3Account>` (if not done already)
2828

29-
In order to join the slack workspace, you must already have your
30-
typo3.org account.
29+
In order to join the slack workspace, you must already have your
30+
typo3.org account.
3131

32-
2. Go to `Slack for TYPO3 on my.typo3.org <https://my.typo3.org/index.php?id=35>`__.
32+
2. Go to `Slack for TYPO3 on my.typo3.org <https://my.typo3.org/index.php?id=35>`__.
3333

34-
On that page, you will also find information about recommended channels.
34+
On that page, you will also find information about recommended channels.
3535

36-
3. Login with your typo3.org account, then go to the "My Profile" tab and select "Use TYPO3 Slack".
36+
3. Login with your typo3.org account, then go to the "My Profile" tab and select "Use TYPO3 Slack".
3737

38-
.. image:: /Images/External/Gerrit/Account/mytypo3profile.png
39-
:class: with-shadow
38+
.. image:: /Images/External/Gerrit/Account/mytypo3profile.png
39+
:class: with-shadow
4040

41-
4. Follow the next steps
41+
4. Follow the next steps
4242

43-
including clicking on the link in the welcome email with
44-
subject "Stefan Busemann has invited you to join a Slack workspace" from slack.
43+
including clicking on the link in the welcome email with
44+
subject "Stefan Busemann has invited you to join a Slack workspace" from slack.
4545

4646
Join #typo3-cms-coredev channel
4747
-------------------------------
4848

49-
.. rst-class:: bignums-xxl
49+
.. rst-class:: bignums-xxl
5050

51-
1. Open Channels Browser
51+
1. Open Channels Browser
5252

53-
Once logged in https://typo3.slack.com, go to Channels Browser by clicking on
54-
*Channels*:
53+
Once logged in https://typo3.slack.com, go to Channels Browser by clicking on
54+
*Channels*:
5555

5656

57-
.. image:: /Images/External/Gerrit/Account/channels.png
58-
:class: with-shadow
57+
.. image:: /Images/External/Gerrit/Account/channels.png
58+
:class: with-shadow
5959

60-
2. Search for coredev-channel and select it:
60+
2. Search for coredev-channel and select it:
6161

62-
.. image:: /Images/External/Gerrit/Account/select-coredev-channel.svg
63-
:class: with-shadow
62+
.. image:: /Images/External/Gerrit/Account/select-coredev-channel.svg
63+
:class: with-shadow
6464

65-
3. Click "Join Channel"
65+
3. Click "Join Channel"
6666

67-
.. image:: /Images/External/Gerrit/Account/join-coredev-channel.png
68-
:class: with-shadow
67+
.. image:: /Images/External/Gerrit/Account/join-coredev-channel.png
68+
:class: with-shadow
6969

7070
More information
7171
----------------

0 commit comments

Comments
 (0)