Skip to content

Commit

Permalink
Add information about building (#277)
Browse files Browse the repository at this point in the history
* Add information about building

- Add information about location of SCSS and TypeScript files
- Add information about building
- Add information about linting

Resolves: #159

* Add changes to Build page
  • Loading branch information
sypets committed Jun 2, 2022
1 parent 7ac410b commit 3a6a0b5
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 0 deletions.
3 changes: 3 additions & 0 deletions Documentation/BugfixingAZ/Index.rst
Expand Up @@ -70,6 +70,9 @@ as described in :ref:`setup <setup>`. Especially the
For new features, breaking changes and deprecations, it is necessary to :ref:`add
information to the changelog <changelog>`.

If you change SCSS, JavaScript or TypeScript files, you can :ref:`build <build>`
locally.

Add Unit Tests or Functional Tests for new functionality, refine existing tests
if necessary. Tests are important because they ensure that
TYPO3 will behave consistently now and in the future.
Expand Down
37 changes: 37 additions & 0 deletions Documentation/Build/Index.rst
@@ -0,0 +1,37 @@
. include:: /Includes.rst.txt

.. highlight:: bash

.. index::
single: Code Contribution Workflow; Build
single: Build
single: SCSS
single: TypeScript
.. _build:

===============
Building assets
===============

This page explains building assets like JavaScript and CSS files.

For the most part, the TypeScript, JavaScript and SCSS sources are contained in
:file:`Build/Sources`. These are compiled to target files, usually located in:

* CSS: :file:`typo3/sysext/*/Resources/Public/Css`
* JavaScript: :file:`typo3/sysext/*/Resources/Public/JavaScript`

If you make changes to the source files, you can build locally using
:ref:`runTests.sh <runTests_sh>`:

.. code-block:: bash
Build/Scripts/runTests.sh -s buildCss
Build/Scripts/runTests.sh -s buildJavascript
It is also possible to lint the files locally:

.. code-block:: bash
Build/Scripts/runTests.sh -s lintScss
Build/Scripts/runTests.sh -s lintTypescript
1 change: 1 addition & 0 deletions Documentation/Index.rst
Expand Up @@ -65,6 +65,7 @@ On these pages you will learn how to become a TYPO3 Core contributor.

ReportingAnIssue/Index
BugfixingAZ/Index
Build/Index
AddingDocumentation/Index
Testing/Index
DebuggingTypo3/Index
Expand Down

0 comments on commit 3a6a0b5

Please sign in to comment.