Skip to content

Commit

Permalink
Remove Aliases page (#313)
Browse files Browse the repository at this point in the history
Additionally, some minor changes in "Adding documenation" to
reduce text (mostly unnecessary bloat). Also, the rendering
documenation commands were removed so that it is documented
only in one place ("Writing documentation").

The aliases page repeated some of the commands in "Setup", "Git cheat
sheet" and for documentation rendering.

Removing content where it is duplicate helps maintainence and keeps
existing content more up to date.

Related: #255
  • Loading branch information
sypets authored Jul 22, 2023
1 parent 39b3c0e commit 6e1a247
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 253 deletions.
55 changes: 8 additions & 47 deletions Documentation/AddingDocumentation/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,10 @@ Add Documentation

**Quick links:**

.. rst-class:: horizbuttons-primary-m

- :ref:`h2document:Formatting-with-reST`
- :ref:`h2document:format-rest-cgl`
- :ref:`h2document:rest-cheat-sheet`
- :ref:`h2document:rendering-docs-quickstart`
- :ref:`h2document:render-documentation-with-docker`


The documentation `Changelog <https://docs.typo3.org/typo3cms/extensions/core/latest/>`__
Expand Down Expand Up @@ -45,22 +43,18 @@ NotScanned, PartiallyScanned or FullyScanned tag for the extension scanner.
See :ref:`t3coreapi:extension-scanner` in TYPO3 Explained for more
information.

If you use the Forger reST File Generator, it will take care of this.

.. index::
single: Tools; reST File Generator
single: Changelog; Generate new Entries
single: Documentation Contribution Workflow; Generating reST Files

.. _rest-file-generator:

reST File Generator
-------------------

.. tip::
Forger reST Helper
------------------

If you want to save yourself some time you can use the rst Helper at
https://forger.typo3.com/utilities/rst
Use the `Forger reST Helper <https://forger.typo3.com/utilities/rst>`__ to
generate changelogs.

This is strongly recommended because the tool will generate correctly
formatted files. You can always add more to the .rst file directly later.
Expand All @@ -69,7 +63,8 @@ Select the type of rst snippet you want to create, enter your issue number
and click the search button. Select appropriate tags.

When you are done, copy the generated text and create a file with the same
name as suggested in the generator.
name as suggested in the generator in
:file:`typo3/sysext/core/Documentation/Changelog/...`.


Types of Changes
Expand Down Expand Up @@ -199,48 +194,14 @@ Render the Changelog
--------------------

If you wish to render the Changelog locally, you can use docker as described
in :ref:`h2document:rendering-docs-quickstart`.

.. code-block:: bash
:caption: shell command
:linenos:
cd typo3/sysext/core/
source <(docker run --rm t3docs/render-documentation show-shell-commands)
dockrun_t3rd makehtml
# on Mac
open "Documentation-GENERATED-temp/Result/project/0.0.0/Index.html"
# on Linux
xdg-open "Documentation-GENERATED-temp/Result/project/0.0.0/Index.html"
# On Windows
start "Documentation-GENERATED-temp/Result/project/0.0.0/Index.html"
cd -
#. First, change to the :file:`core` directory
#. This is a combined command that does docker pull, docker run, and makes some shell commands available in current terminal!
#. This runs the build command, it will create Documentation-GENERATED-temp in current directory
#. `open` will run a URL - this should work on MacOS
#. If you use Linux, use `xdg-open`,
if this does not work, just open the URL in quotes in your browser.
#. cd - goes back to previous directory

.. tip::

The first time you run this, it will take long. :code:`docker pull` will download
the Docker image. The next time, it will be faster, because the image does
not have to be downloaded and `dockrun_t3rd` will not build everything, it will only
build changed files.
in :ref:`h2document:render-documentation-with-docker`.

.. important::

If you switch branches, you should rebuild everything. You can either remove the folder
:file:`Documentation-GENERATED-temp/Cache` and all its contents or run `dockrun_t3rd
makehtml-no-cache` which has the same effect.

Make things easier for yourself by adding these commands as aliases or adding
them as commands in your IDE / editor.

.. _documentation-main:

Policy for Changing the Main Documentation
Expand Down
201 changes: 0 additions & 201 deletions Documentation/Appendix/Aliases.rst

This file was deleted.

5 changes: 0 additions & 5 deletions Documentation/BugfixingAZ/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -198,11 +198,6 @@ please respond in a timely fashion and improve your review. If things are unclea
ask in the **#typo3-cms-coredev** channel on https://typo3.slack.com.


.. tip::

Look at the page :ref:`aliases` for some sample aliases which might help to
simplify your workflow in the future.

Helpful links
=============

Expand Down

0 comments on commit 6e1a247

Please sign in to comment.