Skip to content

Commit

Permalink
[TASK] Align with new TYPO3 documentation standards (#192)
Browse files Browse the repository at this point in the history
* [TASK] Align with new TYPO3 documentation standards

- align README.rst, Settings.cfg, Index.rst, Includes.rst.txt, genindex.rst, Sitemap.rst
- remove outdated Targets.rst

See TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument@c2bb63b for further details.

* [DOCS] Reference manual's start page with :doc:`<manual>:Index`

Adding the custom label `start` to the beginning of the manual's
Index.rst is redundant. Use :doc:`<manual>:Index` instead of
:ref:`<manual:start>` to refer to it.

* [DOCS] Fix rendering warnings

* [DOCS] Apply new intersphinx mapping names
  • Loading branch information
alexander-nitsche authored Mar 29, 2022
1 parent de2b98c commit 050d6ed
Show file tree
Hide file tree
Showing 12 changed files with 137 additions and 143 deletions.
8 changes: 5 additions & 3 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# EditorConfig is awesome: http://EditorConfig.org
# EditorConfig is awesome: https://EditorConfig.org
#
# master file for TYPO3 docs: https://github.com/TYPO3-Documentation/T3DocTeam/blob/main/.editorconfig
# Use as master: https://github.com/TYPO3-Documentation/T3DocTeam/blob/main/.editorconfig

# top-most EditorConfig file
root = false
root = true

[{*.rst,*.rst.txt}]
charset = utf-8
Expand All @@ -12,6 +12,7 @@ insert_final_newline = true
trim_trailing_whitespace = true
indent_style = space
indent_size = 3
max_line_length = 80

# MD-Files
[*.md]
Expand All @@ -21,3 +22,4 @@ insert_final_newline = true
trim_trailing_whitespace = true
indent_style = space
indent_size = 4
max_line_length = 80
6 changes: 3 additions & 3 deletions Documentation/Extensions/Management.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ with a dash in the package name. For example:



Use :shell:`composer require` to install the extension
------------------------------------------------------
Use :bash:`composer require` to install the extension
-----------------------------------------------------

.. code-block:: shell
Expand Down Expand Up @@ -111,7 +111,7 @@ Then run `composer require` to the install the local extension `my-local-extensi
By executing this command, Composer locates `vendor/my-local-extension` and then symlinks
it to `typo3conf/ext/my-local-extension` once `composer install` is executed.
The setup from above defines that the extension is to be placed by composer into the folder `:file:packages/my-local-extension`
The setup from above defines that the extension is to be placed by composer into the folder `:file:packages/my-local-extension`
if it has not been already there.


Expand Down
32 changes: 25 additions & 7 deletions Documentation/Includes.rst.txt
Original file line number Diff line number Diff line change
@@ -1,16 +1,34 @@
.. This is 'Includes.rst.txt'. It is included at the very top of each and
every ReST source file in THIS documentation project (= manual).
.. More information about this file:
https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#includes-rst-txt
.. role:: aspect (emphasis)
.. ----------
.. text roles
.. ----------
.. role:: aspect(emphasis)
.. role:: bash(code)
.. role:: html(code)
.. role:: js(code)
.. role:: php(code)
.. role:: typoscript(code)
.. role:: shell(code)
:class: shell
.. role:: rst(code)
.. role:: sep(strong)
.. role:: sql(code)

.. role:: ts(typoscript)
.. role:: tsconfig(code)
:class: typoscript

.. role:: typoscript(code)
.. role:: xml(code)
:class: html

.. role:: yaml(code)

.. default-role:: code

.. ---------
.. highlight
.. ---------
.. By default, code blocks use PHP syntax highlighting
.. highlight:: php
47 changes: 37 additions & 10 deletions Documentation/Index.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,36 @@
.. include:: /Includes.rst.txt

.. _start:
================================
TYPO3 - Getting Started Tutorial
================================

===============
Getting Started
===============
:Version:
|release|

Welcome to Getting Started, this guide features an introduction to TYPO3 that highlights some of its core concepts including the backend
administrative interface.
:Language:
en

This guide also contains information on how to configure the host operating system and features a detailed installation guide
that explains how TYPO3 is installed.
:Author:
TYPO3 contributors

:License:
This document is published under the
`Open Publication License <https://www.opencontent.org/openpub/>`__.

:Rendered:
|today|

----

Welcome to Getting Started, this guide features an introduction to TYPO3 that
highlights some of its core concepts including the backend administrative
interface.

This guide also contains information on how to configure the host operating
system and features a detailed installation guide that explains how TYPO3 is
installed.

----

.. container:: row m-0 p-0

Expand Down Expand Up @@ -124,6 +144,7 @@ that explains how TYPO3 is installed.

Next Steps provides an overview of tasks that can be carried out once TYPO3 is installed, such as creating templates and adding content.

.. Table of Contents
.. toctree::
:hidden:
Expand All @@ -138,5 +159,11 @@ that explains how TYPO3 is installed.
UserManagement/Index
IntroductionPackage/Index
NextSteps/Index
Sitemap
genindex

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

Sitemap
genindex
22 changes: 11 additions & 11 deletions Documentation/Installation/Install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,32 +8,32 @@
Installing TYPO3
================

Welcome to the TYPO3 installation guide. This guide covers each of the steps required
Welcome to the TYPO3 installation guide. This guide covers each of the steps required
to install TYPO3 using the dependency manager Composer.

Installation and deployment
---------------------------

It is recommended to not use Composer on a productive system to update and install
It is recommended to not use Composer on a productive system to update and install
additional packages. Such changes should be made on a development system (locally in
DDEV, on a non-productive part of the server, ...)

This way it can be prevented to install unwanted versions of packages. The files
This way it can be prevented to install unwanted versions of packages. The files
:file:`composer.json` and :file:`composer.lock` can be kept under version control
and specify exactly what versions should be installed.

Deployment to the productive system can be achieved by deploying these two
:file:`composer.*` files and calling
Deployment to the productive system can be achieved by deploying these two
:file:`composer.*` files and calling

.. code-block:: shell
composer install --no-dev
.. warning::
Always use the :shell:`--no-dev` parameter to prevent installing packages marked as
.. warning::
Always use the :bash:`--no-dev` parameter to prevent installing packages marked as
"development only" to be deployed on the productive server.
Or by executing the above command on a development system or in a Docker container

Or by executing the above command on a development system or in a Docker container
in a deployment pipeline and then just transfer the following folders:

.. code-block:: none
Expand Down
4 changes: 2 additions & 2 deletions Documentation/NextSteps/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Next Steps and Further Reading
Once TYPO3 is installed, it is now possible to start the process of developing
the site's visual appearance and creating pages and content inside the CMS.

:ref:`Building The Sites Structure And Adding Content <t3editors:start>`
:doc:`Building The Sites Structure And Adding Content <t3editors:Index>`
========================================================================

Using the Page tree - start to define the structure of your site by creating pages.
Expand All @@ -31,7 +31,7 @@ There are two main topics that cover templating in TYPO3, Fluid and Site package
Fluid is TYPO3’s templating engine. Fluid acts as the link between a project's
static HTML templates and the content that is created in TYPO3’s backend.

:ref:`Site Packages <t3sitepackage:start>`
:doc:`Site Packages <t3sitepackage:Index>`
++++++++++++++++++++++++++++++++++++++++++

Site packages are a type of extension that act as a storage point for a projects
Expand Down
93 changes: 47 additions & 46 deletions Documentation/Settings.cfg
Original file line number Diff line number Diff line change
@@ -1,61 +1,62 @@
# coding: utf-8

# #####
#
# Settings.cfg - A TYPO3 Documentation Project's Configuration File
#
# About Syntax:
# See https://docs.python.org/2/library/configparser.html
#
# Put comments in separate lines!
#
# #####


# Attention:
# LEAVE RIGHT SIDE EMPTY for a 'false' value like:
# example_of_false_value =

# More information about this file:
# https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#settings-cfg

[general]

; endless list of all of the general simple settings
; you can use in 'conf.py'

project = Getting Started
version = main (development)
release = main (development)
t3author = Documentation Team
copyright = since 2004 by the TYPO3 Documentation Team
description = A Tutorial to get started with TYPO3

copyright = since 2012 by the TYPO3 contributors

[html_theme_options]

# for "Edit me on GitHub

github_branch = main
# "Edit on GitHub" button
github_repository = TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted
github_branch = main


project_contact = https://typo3.org/community/teams/documentation/#c9886
project_discussions =
project_home =
project_issues = https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted/issues
# Footer links
project_home = https://docs.typo3.org/m/typo3/tutorial-getting-started/main/en-us/
project_contact = https://typo3.slack.com/archives/C028JEPJL
project_repository = https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted
project_issues = https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted/issues
project_discussions =

[intersphinx_mapping]

; in this manual we actually use:

h2document = https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/
t3coreapi = https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/
t3editors = https://docs.typo3.org/m/typo3/tutorial-editors/main/en-us/
t3sitepackage = https://docs.typo3.org/m/typo3/tutorial-sitepackage/main/en-us/
workspaces = https://docs.typo3.org/c/typo3/cms-workspaces/main/en-us/

[extensions]
use_opensearch =

; embed YouTube videos
any_name_youtube = sphinxcontrib.youtube
[intersphinx_mapping]

# Official TYPO3 manuals
# h2document = https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/
# t3cheatsheets = https://docs.typo3.org/m/typo3/docs-cheatsheets/main/en-us/
# t3contribute = https://docs.typo3.org/m/typo3/guide-contributionworkflow/main/en-us/
t3coreapi = https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/
# t3docteam = https://docs.typo3.org/m/typo3/team-t3docteam/main/en-us/
t3editors = https://docs.typo3.org/m/typo3/tutorial-editors/main/en-us/
# t3extbasebook = https://docs.typo3.org/m/typo3/book-extbasefluid/main/en-us/
# t3extexample = https://docs.typo3.org/m/typo3/guide-example-extension-manual/main/en-us/
# t3home = https://docs.typo3.org/
# t3install = https://docs.typo3.org/m/typo3/guide-installation/main/en-us/
# t3l10n = https://docs.typo3.org/m/typo3/guide-frontendlocalization/main/en-us/
t3sitepackage = https://docs.typo3.org/m/typo3/tutorial-sitepackage/main/en-us/
# t3start = https://docs.typo3.org/m/typo3/tutorial-getting-started/main/en-us/
# t3tca = https://docs.typo3.org/m/typo3/reference-tca/main/en-us/
# t3templating = https://docs.typo3.org/m/typo3/tutorial-templating/main/en-us/
# t3translate = https://docs.typo3.org/m/typo3/guide-frontendlocalization/main/en-us/
# t3tsconfig = https://docs.typo3.org/m/typo3/reference-tsconfig/main/en-us/
# t3tsref = https://docs.typo3.org/m/typo3/reference-typoscript/main/en-us/
# t3ts45 = https://docs.typo3.org/m/typo3/tutorial-typoscript-in-45-minutes/main/en-us/
# t3viewhelper = https://docs.typo3.org/other/typo3/view-helper-reference/main/en-us/
# t3upgrade = https://docs.typo3.org/m/typo3/guide-installation/main/en-us/

# TYPO3 system extensions
# ext_adminpanel = https://docs.typo3.org/c/typo3/cms-adminpanel/main/en-us/
# ext_core = https://docs.typo3.org/c/typo3/cms-core/main/en-us/
# ext_dashboard = https://docs.typo3.org/c/typo3/cms-dashboard/main/en-us/
# ext_felogin = https://docs.typo3.org/c/typo3/cms-felogin/main/en-us/
# ext_form = https://docs.typo3.org/c/typo3/cms-form/main/en-us/
# ext_fsc = https://docs.typo3.org/c/typo3/cms-fluid-styled-content/main/en-us/
# ext_indexed_search = https://docs.typo3.org/c/typo3/cms-indexed-search/main/en-us/
# ext_rte_ckeditor = https://docs.typo3.org/c/typo3/cms-rte-ckeditor/main/en-us/
# ext_scheduler = https://docs.typo3.org/c/typo3/cms-scheduler/main/en-us/
# ext_seo = https://docs.typo3.org/c/typo3/cms-seo/main/en-us/
ext_workspaces = https://docs.typo3.org/c/typo3/cms-workspaces/main/en-us/
4 changes: 2 additions & 2 deletions Documentation/Sitemap.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
:template: sitemap.html

.. _sitemap:
.. include:: /Includes.rst.txt

=======
Sitemap
=======

.. template 'sitemap.html' will insert the toctree as a sitemap here below normal contents
.. The sitemap.html template will insert here the page tree automatically.
44 changes: 0 additions & 44 deletions Documentation/Targets.rst

This file was deleted.

2 changes: 1 addition & 1 deletion Documentation/UserManagement/GroupPermissions/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ which parts of the page tree and the file system the members of
the group may exert their rights over.

We will cover only mounts here. Detailed information about
workspaces can be found in the :ref:`related extension manual <workspaces:start>`.
workspaces can be found in the :doc:`related extension manual <ext_workspaces:Index>`.


.. _db-mounts:
Expand Down
Loading

0 comments on commit 050d6ed

Please sign in to comment.