Skip to content

Commit 790b889

Browse files
committed
[TASK] Improve rendering page
Resolves: #464
1 parent c493123 commit 790b889

File tree

3 files changed

+20
-4
lines changed

3 files changed

+20
-4
lines changed

Documentation/Howto/EditLocal.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ the ability to experiment and preview your changes locally before submitting the
9090

9191
Render your changes with Docker to preview them locally:
9292

93-
* :ref:`render-documenation-with-docker`
93+
* :ref:`render-documentation-with-docker`
9494

9595
8. Commit
9696

Documentation/Howto/RenderingDocs/Index.rst

+18-2
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,27 @@
88
Rendering; Commands
99
.. _rendering-docs:
1010
.. _rendering-docs-quickstart:
11-
.. _render-documenation-with-docker:
12-
.. _render-documentation-with-docker:
1311

1412
=========================================
1513
Render documentation with the TYPO3 theme
1614
=========================================
1715

16+
You can render documentation by executing the following command in the folder
17+
that contains the :path:`Documentation` folder:
18+
19+
.. include:: /_Includes/_LocalRendering.rst.txt
20+
21+
The official manuals commonly contain a make file. You
22+
can use the short command:
23+
24+
.. code-block::
25+
26+
make docs
27+
1828
.. contents::
1929

30+
.. _render-documentation-with-docker:
31+
2032
Rendering the :file:`Documentation` folder locally with Docker
2133
==============================================================
2234

@@ -134,6 +146,7 @@ you can create a bash alias like:
134146
`5173` you need to adapt that command to use another free TCP port for you,
135147
and adapt the port in the web-browser URL.
136148

149+
.. _publish-documentation:
137150

138151
Publishing extension documentation to docs.typo3.org
139152
====================================================
@@ -148,6 +161,9 @@ The extension has to be publicly available on GitHub or GitLab. You have to
148161
establish a :ref:`Webhook <webhook>` and the Documentation Team has to
149162
:ref:`approve <approval-intercept>` your first rendering.
150163

164+
165+
.. _test-documentation:
166+
151167
Introduce automatic testing for extension documentation
152168
=======================================================
153169

Documentation/Howto/WritingDocForExtension/Index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Use the following Docker command to render your documentation guide locally:
2424

2525
.. include:: /_Includes/_LocalRendering.rst.txt
2626

27-
The :ref:`render-documenation-with-docker` has more information.
27+
The :ref:`render-documentation-with-docker` has more information.
2828

2929
.. _how-to-start-docs-extension:
3030

0 commit comments

Comments
 (0)