Commit 4333a55a authored by Fabien Udriot's avatar Fabien Udriot
Browse files

[TASK] Update general content

Change-Id: Ib45a120cfdef7889d63153980777fb84461f27bb
parent 7612aa35
<ul class="breadcrumbs">
<li>
<a href="http://typo3.org/" target="_top" title="TYPO3 - The Enterprise Open Source CMS">typo3.org</a>
</li>
<li>
<a href="http://typo3.org/download/" target="_top" title="Download">Download</a>
</li>
<li>TYPO3 CMS Composer Repository</li>
</ul>
composer.typo3.org
==================
This repository contains the web pages for http://composer.typo3.org.
TYPO3 CMS Composer Repository
=============================
Installation
------------
To install it locally:
What Is It?
-----------
# Clone the repository
git clone git://git.typo3.org/Sites/ComposerTypo3Org.git
This is a [composer][1] repository, enabling you to install TYPO3 CMS core and extensions including dependencies via Composer.
This repository includes:
# Install packages dependencies
cd ComposerTypo3Org
composer install
# Download typo3.org landing page sub-module
git submodule update --init
* TYPO3 CMS core. All versions currently supported by [typo3.org](http://typo3.org/download/)
* TYPO3 CMS extensions. All Extensions, not marked as un-secure, in the [TER](http://typo3.org/extensions/repository/)
* Composer Installer. To install everything into its right place (typo3conf/ext and typo3_src)
Contributing
------------
How to use it?
--------------
To change and submit the content of this website, send patches to Gerrit:
As a quick way, to use Composer, the Base Distribution can be downloaded. It can be done in a few commands:
# Install the Gerrit Hook
scp -p -P 29418 USERNAME@review.typo3.org:hooks/commit-msg .git/hooks/
# Install Composer on your system if not already done.
https://getcomposer.org/download/
# After committing your changes, push to a special branch for review
git push origin HEAD:refs/for/master
# Download the Base Distribution.
composer create-project typo3/cms-base-distribution CmsBaseDistribution
# Add and download additional extensions.
cd CmsBaseDistribution
composer require typo3-ter/tt-news
# Personalize your composer.json file.
edit composer.json
As you can see, using composer to install TYPO3 CMS is fairly simple. You just need to include the custom composer repository into your composer.json.
After you have done this, you can require the Core and / or extensions with the usual [composer versioning format][2].
In the example below, this will always get you the most current 6.2.x core of TYPO3 CMS, the most current version of a1_ttnews (including it's dependency tt_news!).
{
"repositories": [
{
"type": "composer",
"url": "http://composer.typo3.org/"
}
],
"require": {
"typo3/cms": "~6.2",
"typo3-ter/a1_ttnews": "*"
}
}
Add your own composer.json file
-------------------------------
It is encouraged to add your own ``composer.json`` file in your extension to be on the good side, as TYPO3 CMS will rely more and more on Composer to handle
dependencies. The file must be placed at the root of your extension and must look like as follows:
{
"name": "vendor-name/my-ext",
"type": "cms-extension",
"description": "My description comes here",
"homepage": "http://example.com",
"license": ["GPL-2.0+"]
}
The ``vendor-name`` must be one of yours. It must not be "typo3" which is reserved for Core extensions.
There are some [conventions notes](http://wiki.typo3.org/Namespaces#Does_and_don.27ts_for_developers) to be read in the TYPO3 Wiki related to namespaces.
Also, you have the chance to synchronise your package on Packagist, if you are hosting your code on git.typo3.org.
The benefit would be to be able to use the "master" branch as long as the "tags" - which is not possible with the TER. To have this possible, make sure to:
* Have a Composer file at the root of the extension, as shown above.
* Register the package at [Packagist](https://packagist.org/packages/submit)
* Add "typo3" as additional maintainer of your package on Packagist. This is required to have Gerrit's hook correctly triggering the update on Packagist.
How it works?
-------------
A few times a day we crawl the TYPO3 Extension Repository and the available core downloads.
We process all ext_emconf.php's (of every non un-secure version) to calculate the dependencies.
We generate the metadata (packages.json), needed by composer to find the right downloads which will be downloaded from the TER eventually.
Where can I report bug?
-----------------------
There is a [Forge project][fp] where issues and wishes can be reported on the [Bug Tracker][bt].
[1]: http://getcomposer.org/
[2]: http://getcomposer.org/doc/04-schema.md#version
[fp]: https://forge.typo3.org/projects/team-composer
[bt]: https://forge.typo3.org/projects/team-composer/issues
<ul class="breadcrumbs">
<li>
<a href="http://typo3.org/" target="_top" title="TYPO3 - The Enterprise Open Source CMS">typo3.org</a>
</li>
<li>
<a href="http://typo3.org/download/" target="_top" title="Download">Download</a>
</li>
<li>TYPO3 CMS Composer Repository</li>
</ul>
TYPO3 CMS Composer Repository
=============================
What Is It?
-----------
This is a [composer][1] repository, enabling you to install TYPO3 CMS core and extensions including dependencies via Composer.
This repository includes:
* TYPO3 CMS core. All versions currently supported by [typo3.org](http://typo3.org/download/)
* TYPO3 CMS extensions. All Extensions, not marked as un-secure, in the [TER](http://typo3.org/extensions/repository/)
* Composer Installer. To install everything into its right place (typo3conf/ext and typo3_src)
How to use it?
--------------
As a quick way to use Composer, the Base Distribution can be downloaded. It is assuming you have Composer already [installed][2]
on your system:
# Download the Base Distribution.
composer create-project typo3/cms-base-distribution CmsBaseDistribution
As a second step, we are going to add additional packages. The commands must be run from inside the ``CmsBaseDistribution`` directory.
# Add a CMS extension into typo3conf/ext,
composer require typo3-ter/news
-> if asked for a version constraint, answer with *.
# Add a package from outside the CMS world into Packages/Libraries
# Notice: Packages/Libraries/autoload.php will need to be included in your code.
composer require monolog/monolog
# Personalize your composer.json file to your needs.
edit composer.json
As you can see, using composer to install TYPO3 CMS is fairly simple. You just need to include the custom composer repository into your composer.json.
After you have done this, you can require the Core and / or extensions with the usual [composer versioning format][3].
In the example below, this will always get you the most current 6.2.x core of TYPO3 CMS, the most current version of news (including possible dependency!).
{
"repositories": [
{
"type": "composer",
"url": "http://composer.typo3.org/"
}
],
"require": {
"typo3/cms": "~6.2",
"typo3-ter/news": "*"
}
}
Add your own composer.json file
-------------------------------
It is encouraged to add your own ``composer.json`` file in your extension to be on the good side, as TYPO3 CMS will rely more and more on Composer to handle
dependencies. The file must be placed at the root of your extension and must look like as follows:
{
"name": "vendor-name/my-ext",
"type": "cms-extension",
"description": "My description comes here",
"homepage": "http://example.com",
"license": ["GPL-2.0+"]
}
The ``vendor-name`` must be one of yours. It must not be "typo3" which is reserved for Core extensions.
There are some [conventions notes](http://wiki.typo3.org/Namespaces#Does_and_don.27ts_for_developers) to be read in the TYPO3 Wiki related to namespaces.
Also, you have the chance to synchronise your package on Packagist, if you are hosting your code on git.typo3.org.
The benefit would be to be able to use the "master" branch as long as the "tags" - which is not possible with the TER. To have this possible, make sure to:
* Have a Composer file at the root of the extension, as shown above.
* Register the package at [Packagist](https://packagist.org/packages/submit)
* Add "typo3" as additional maintainer of your package on Packagist. This is required to have Gerrit's hook correctly triggering the update on Packagist.
How it works?
-------------
A few times a day we crawl the TYPO3 Extension Repository and the available core downloads.
We process all ext_emconf.php's (of every non un-secure version) to calculate the dependencies.
We generate the metadata (packages.json), needed by composer to find the right downloads which will be downloaded from the TER eventually.
Where can I report bug?
-----------------------
There is a [Forge project][fp] where issues and wishes can be reported on the [Bug Tracker][bt].
If you would like to amend the content of this page, head to the [ComposerTypo3Org][4] repository, clone it
and refer to the README file to send patch review.
[1]: http://getcomposer.org/
[2]: https://getcomposer.org/download/
[3]: http://getcomposer.org/doc/04-schema.md#version
[4]: https://git.typo3.org/Sites/ComposerTypo3Org.git
[fp]: https://forge.typo3.org/projects/team-composer
[bt]: https://forge.typo3.org/projects/team-composer/issues
......@@ -5,7 +5,7 @@ require 'Packages/Libraries/autoload.php';
$template = 'Resources/template.html';
$output = file_get_contents($template);
$contentFile = 'README.md';
$contentFile = 'index.md';
$contentRaw = file_get_contents($contentFile);
$parser = new Parsedown();
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment