Skip to content

Commit 3757300

Browse files
github-actions[bot]Kiebele
andauthored
[Backport 13.4] Add prerequisites at the beginning (#607)
* [TASK] Add prerequisites * [FIX] Add prerequisites to toctree * [FIX] Adjust Prerequisites --------- Co-authored-by: Kiebele <[email protected]>
1 parent 5ae6a81 commit 3757300

File tree

2 files changed

+86
-3
lines changed

2 files changed

+86
-3
lines changed

Documentation/Index.rst

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,14 @@ system and detailed information on how to install TYPO3.
2121
:class: pb-4
2222
:card-height: 100
2323

24+
.. card:: Prerequisites
25+
26+
In this section we mention the prerequisites that you need before
27+
you start with this tutorial.
28+
29+
.. card-footer:: :ref:`See the prerequisites <Prerequisites>`
30+
:button-style: btn btn-secondary stretched-link
31+
2432
.. card:: Concepts
2533

2634
Written for new users, this chapter introduces some of TYPO3's core
@@ -29,9 +37,6 @@ system and detailed information on how to install TYPO3.
2937
.. card-footer:: :ref:`Learn about the basic concepts <Concepts>`
3038
:button-style: btn btn-secondary stretched-link
3139

32-
.. card-footer:: :ref:`Learn more about TYPO3 Concepts <Concepts>`
33-
:button-style: btn btn-secondary stretched-link
34-
3540
.. card:: Installation
3641

3742
The installation chapter provides detailed instructions on how to
@@ -78,6 +83,7 @@ system and detailed information on how to install TYPO3.
7883
:hidden:
7984
:titlesonly:
8085

86+
Prerequisites/Index
8187
Concepts/Index
8288
Installation/Index
8389
FirstProject/Index
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
:navigation-title: Prerequisites
2+
.. include:: /Includes.rst.txt
3+
4+
.. _prerequisites:
5+
6+
=================================
7+
Prerequisites to start with TYPO3
8+
=================================
9+
10+
Before you start working on this tutorial, you should have DDEV installed on
11+
your computer.
12+
13+
This TYPO3 tutorial assumes that the reader has some basic knowledge in the following areas:
14+
15+
* `HTML, CSS and JavaScript <https://www.w3schools.com/html/default.asp>`__
16+
* `Basic Command Line Interface (CLI) Commands <https://www.w3schools.com/whatis/whatis_cli.asp>`__
17+
18+
.. _composer_cheat_sheat:
19+
20+
Composer cheat sheet
21+
====================
22+
23+
Composer is a powerful tool for managing dependencies in PHP projects, including
24+
TYPO3. Here you will find an overview of the four most important commands with a
25+
simple explanation of what they do.
26+
27+
.. _composer_require:
28+
29+
composer require
30+
----------------
31+
32+
.. code-block:: bash
33+
34+
composer require vendor/extension-name
35+
36+
It installs a new package (e.g. a TYPO3 extension) and automatically adds it to your :guilabel:`composer.json`.
37+
Composer determines the appropriate version based on your current configuration.
38+
All required dependencies for the package are also installed.
39+
40+
.. _composer_remove:
41+
42+
composer remove
43+
---------------
44+
45+
.. code-block:: bash
46+
47+
composer remove vendor/extension-name
48+
49+
Uninstalls an existing package from your project.
50+
Removes the entry from :guilabel:`composer.json` and deletes related files from the
51+
:guilabel:`vendor` folder.
52+
Removes unused dependencies that were only required fro the removed package.
53+
54+
.. _composer_install:
55+
56+
composer install
57+
----------------
58+
59+
.. code-block:: bash
60+
61+
composer install
62+
63+
It installs exactly the versions specified in the :guilabel:`composer.lock` file.
64+
65+
.. _composer_update:
66+
67+
composer update
68+
---------------
69+
70+
.. code-block:: bash
71+
72+
composer update
73+
74+
It updates all installed packages to their latest version, as allowed by the version constraints in :guilabel:`composer.json`.
75+
The :guilabel:`composer.lock` file, which records the exact package versions, is updated.
76+
Downloads the updated packages to the :guilabel:`vendor` folder.
77+

0 commit comments

Comments
 (0)