Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Prerequisites #186

Merged
merged 1 commit into from
Oct 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 28 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,25 @@ 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:

Preface/Index
Introduction/Index
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
22 changes: 0 additions & 22 deletions Documentation/Introduction/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,25 +87,3 @@ accessible version control system such as `GitHub <https://github.com>`__.

Last, but not least, configuration settings in the sitepackage can
be overwritten using TypoScript setup and constants.


.. _prerequisites:

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

This TYPO3 tutorial assumes that the reader has some basic knowledge in the
following areas:

* HTML, CSS and JavaScript
* SSH/FTP (copy files and directories to and from the server)

It is also recommended that the reader has worked with TYPO3 before, knows what
the *frontend*, *backend* and *Extension Manager* are and how to access the
*Install Tool*. Missing knowledge can be acquired by working through the TYPO3
documentation, for example the :doc:`Getting Started Tutorial <t3start:Index>`.

The sitepackage in this tutorial will build a new, clean website from scratch,
so it is assumed you have an empty TYPO3 instance with no pages, design
templates, configuration, etc. You will need a valid TYPO3 backend user login with
administrator privileges and SSH/FTP access to the server is recommended.
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.
46 changes: 46 additions & 0 deletions Documentation/Prerequisites/Index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
.. 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 log in 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)

This TYPO3 tutorial assumes that the reader has some basic knowledge in the
following areas:

* HTML, CSS and JavaScript
* DDEV
* Composer

It is also helpful if you know the following concepts:

* Backend
linawolf marked this conversation as resolved.
Show resolved Hide resolved
* 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
Loading