Skip to content

Commit

Permalink
Update Prerequisites
Browse files Browse the repository at this point in the history
Also remove Introduction and preface as they contain mostly outdated information

resolves: #184
resolves: #183
Releases: main
  • Loading branch information
linawolf committed Oct 6, 2024
1 parent 13bb901 commit 76a892f
Show file tree
Hide file tree
Showing 6 changed files with 66 additions and 224 deletions.
75 changes: 26 additions & 49 deletions Documentation/Index.rst
Original file line number Diff line number Diff line change
@@ -1,34 +1,14 @@
.. include:: /Includes.rst.txt
.. _start:

==========================
TYPO3 Sitepackage Tutorial
==========================
===========================
TYPO3 site package tutorial
===========================

:Version:
|release|
This tutorial describes step by step how to come from your first TYPO3
installation to the first basic site.

:Language:
en

:Author:
Michael Schams & TYPO3 contributors

:License:
This document is published under the
`Creative Commons BY-NC-SA 4.0 <https://creativecommons.org/licenses/by-nc-sa/4.0/>`__
license.

:Rendered:
|today|

----

This tutorial describes how to create a fully functional TYPO3 website from
design templates (HTML, CSS, JavaScript, etc.) by using a
*sitepackage extension*.

A working copy of the sitepackage extension can be retrieved from the
A working copy of the site package extension can be retrieved from the
`TYPO3CMS-Tutorial-SitePackage-Code`_ repository.

.. _TYPO3CMS-Tutorial-SitePackage-Code: https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-SitePackage-Code/tree/main
Expand All @@ -37,26 +17,23 @@ A working copy of the sitepackage extension can be retrieved from the

**Table of Contents:**

.. toctree::
:maxdepth: 2
:titlesonly:

Preface/Index
Introduction/Index
MinimalExample/Index
DesignTemplate/Index
FluidTemplates/Index
TypoScriptConfiguration/Index
ExtensionConfiguration/Index
ExtensionInstallation/Index
CreatePages/Index
MainMenuCreation/Index
ContentMapping/Index
Summary/Index

.. Meta Menu
.. toctree::
:hidden:

Sitemap
.. toctree::
:maxdepth: 2
:titlesonly:

Prerequisites/Index
MinimalExample/Index
DesignTemplate/Index
FluidTemplates/Index
TypoScriptConfiguration/Index
ExtensionConfiguration/Index
ExtensionInstallation/Index
CreatePages/Index
MainMenuCreation/Index
ContentMapping/Index
Summary/Index

.. toctree::
:hidden:

Sitemap
111 changes: 0 additions & 111 deletions Documentation/Introduction/Index.rst

This file was deleted.

63 changes: 0 additions & 63 deletions Documentation/Preface/Index.rst

This file was deleted.

Binary file added Documentation/Prerequisites/EmptyInstallation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
39 changes: 39 additions & 0 deletions Documentation/Prerequisites/Index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
.. include:: /Includes.rst.txt

.. _prerequisites:

=============
Prerequisites
=============

Before you start working on this tutorial you should have a working TYPO3
installation in versions 13.3 or above.

We assume you use Composer and work locally with DDEV.

Your TYPO3 installation should be empty and have no pages, designs or third
party extensions installed.

You can follow this tutorial to install TYPO3 with DDEV and Composer:

* :ref:`Installing TYPO3 with DDEV <t3start:installation-ddev-tutorial>`.

.. note:: Answer "no" when asked if you want to create a basic site.

You should be able to look into the TYPO3 backend and see the following:

.. figure:: EmptyInstallation.png
:alt: Screenshot of a fresh TYPO3 13.4-dev installation with no page in the page tree

A fresh, empty TYPO3 installation (light mode)

It is also helpful if you know the following concepts:

* Backend
* Frontend
* Page tree
* How to create a page
* How to create page content
* The page module
* The list module
* The TypoScript module
2 changes: 1 addition & 1 deletion Documentation/Summary/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ also download the extension built in this tutorial below.
Download sitepackage Extension
-------------------------------

`GitHub <https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-SitePackage-Code>`_
`GitHub <https://github.com/TYPO3-Documentation/site_package>`_


.. _site-package-builder:
Expand Down

0 comments on commit 76a892f

Please sign in to comment.