contao / docs-archive

Contao Documentation
https://docs.contao.org/
Other
43 stars 77 forks source link

Add the "folder structure" chapter and modify the "extension" chapter #370

Closed lionel-m closed 7 years ago

lionel-m commented 8 years ago

This is the same as #345 but without adding a new chapter.

aschempp commented 8 years ago

Wow, this is great!

Two things:

lionel-m commented 8 years ago

Contao 3 extensions can also be installed with Composer, if the developer said them to be compatible with Contao 4

Ok I will separate into two sub-chapter "with Composer" and "manually".

I would suggest to write the full class name instead of a use statement in the kernel.

Can I have an example please?

aschempp commented 8 years ago

Can I have an example please?

public function registerBundles()
{
    $bundles = [
        new Symfony\Bundle\FrameworkBundle\FrameworkBundle(),
        new Contao\CoreBundle\ContaoCoreBundle(),
        new Contao\CoreBundle\HttpKernel\Bundle\ContaoModuleBundle('myExtensionName', $this->getRootDir()),
    ];

    return $bundles;
}
lionel-m commented 8 years ago

Thanks!

lionel-m commented 8 years ago

Contao 3 extensions can also be installed with Composer, if the developer said them to be compatible with Contao 4

I added this part in 7bc9f0f8605bc9f36395a5834e07d4e516825c2b. Should we add a line in the app/AppKernel.php file if we install an extension with Composer?

lionel-m commented 8 years ago

@aschempp Could you add a new branch for the 4.2 please

lionel-m commented 8 years ago

@aschempp I made all the changes.

aschempp commented 8 years ago

Public files of each bundle are located in the web/bundles folder through symlinks. These can be regenerated from the back end under maintenance.

Not sure if that's correct. @leofeyer do we call assets:install from the backend or just contao:symlinks?

aschempp commented 8 years ago

The part about installing extensions is a bit confusing to me. It explains about bundles, but what we're installing in the example seems to be old Contao 3 extensions. Are you intentionally not mentioning how to install a real bundle? Maybe we should be more clear about the differences?

lionel-m commented 8 years ago

Are you intentionally not mentioning how to install a real bundle? Maybe we should be more clear about the differences?

No it's not intentional. I will improve this point... Add the installation of a real bundle and make the difference between the two types of extension.

leofeyer commented 8 years ago

Just contao:symlinks.

lionel-m commented 8 years ago

No it's not intentional. I will improve this point... Add the installation of a real bundle and make the difference between the two types of extension.

@aschempp it's better now WDYT?

aschempp commented 8 years ago

Great progress! For a Contao 3 extension to be installed in Contao 4, a developer has to mark it as compatible. Therefore the warning about compatibility should probably go into the "manual installation" section, what do you think?

We should also add a link to Packagist that lists all Contao things, they currently look like this: https://packagist.org/search/?q=&type=contao-bundle (Contao 4 bundles) or https://packagist.org/search/?q=&type=contao-module (Contao 3 extensions)

lionel-m commented 8 years ago

I removed the warning and improved the existing chapter (Contao modules) on this subject in c066a7c9f679e44910a1eb5c26d2c9e927aed069.

lionel-m commented 8 years ago

We should also add a link to Packagist that lists all Contao things, they currently look like this: https://packagist.org/search/?q=&type=contao-bundle (Contao 4 bundles) or https://packagist.org/search/?q=&type=contao-module (Contao 3 extensions)

I added a new sub-chapter (Finding extensions or bundles).

lionel-m commented 8 years ago

What do you think about changing the chapter name: "Extensions and bundles" instead of "Extensions" only?

aschempp commented 8 years ago

I like it 😎 We should maybe add more information about the different types of extensions, and why you should use one or the other. I could create a pull request for you with my ideas, ok?

lionel-m commented 8 years ago

I could create a pull request for you with my ideas, ok?

Yes thx 👍

lionel-m commented 8 years ago

@aschempp I recreate this PR for the 4.2 branch with the last changes?

UPDATE: https://github.com/blog/2224-change-the-base-branch-of-a-pull-request 👍

aschempp commented 7 years ago

Reviewed this again. I wonder if the folder structure belongs to the chapter "installing Contao"? Not really relevant for a regular user, is it? Maybe we should move this to a cookbook chapter, what do you think?

lionel-m commented 7 years ago

Reviewed this again. I wonder if the folder structure belongs to the chapter "installing Contao"? Not really relevant for a regular user, is it? Maybe we should move this to a cookbook chapter, what do you think?

OK I will create a chapter with this part in the cookbook and recreating this PR that will target the 4.2 branch.

lionel-m commented 7 years ago

Closed in favor of #424 and #425.