Skip to content

[TASK] Rename FAQ part of introduction, move introduction info to sta… #226

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.

Sign up for GitHub

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

Merged
linawolf merged 1 commit into from
Nov 10, 2024
Merged

[TASK] Rename FAQ part of introduction, move introduction info to sta… #226

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 7 additions & 16 deletions Documentation/Introduction/Index.rst → Documentation/Faq/Index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,12 @@
:navigation-title: FAQ
.. include:: /Includes.rst.txt

.. _introduction:
.. _site-package-benefits:
.. _faq:

=====================================
Introduction into using site packages
=====================================

A site package is a custom TYPO3 extension that contains files regarding the
theme and functionality of a site.

For further reading see also:
:ref:`TYPO3 explained: Introduction into using site packages <t3coreapi:site-package-introduction>`.
==========================
Frequently asked questions
==========================

.. contents::

Expand Down Expand Up @@ -49,19 +43,16 @@ When not to put files in a site package
=======================================

If you are developing functionality that may need to be shared across multiple sites
or TYPO3 installations in the future, it is advisable to create a custom extension
or TYPO3 installations in the future, it is advisable to create a
:ref:`custom extension <t3start:create-own-extension>`
for that functionality instead.

.. todo: Add link to how to create a custom extension once documented in
Once https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted/issues/450
is resolved

.. _introduction-download:

Where to download the example site package
==========================================

You can download the example site package use in this tutorial from GitHub:
You can download the example site package used in this tutorial from GitHub:
https://github.com/TYPO3-Documentation/site_package

.. note::
Expand Down
14 changes: 10 additions & 4 deletions Documentation/Index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,23 @@
.. include:: /Includes.rst.txt
.. _introduction:
.. _start:

===========================
TYPO3 site package tutorial
===========================

A site package is a custom :ref:`TYPO3 extension <t3start:concepts-extensions>`
that contains files regarding the theme and functionality of a site.

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

A working copy of the site package extension can be retrieved from the
`TYPO3CMS-Tutorial-SitePackage-Code`_ repository.
You can download the example site package used in this tutorial from GitHub:
https://github.com/TYPO3-Documentation/site_package

.. _TYPO3CMS-Tutorial-SitePackage-Code: https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-SitePackage-Code/tree/main
.. note::
The example site package is structured for educational purposes and is
not intended for use in production environments.

----

Expand Down Expand Up @@ -155,7 +161,7 @@ A working copy of the site package extension can be retrieved from the
MainMenuCreation/Index
SiteSets/Index
ExtensionConfiguration/Index
Introduction/Index
Faq/Index
Summary/Index

.. toctree::
Expand Down