sulu / sulu-docs Goto Github PK

How is the Content structured in Sulu?
Which elements do exist?
Which should be used?

• Which problems does Sulu solve?
• What it isn't made for?

• Show the core concepts in a infographic.
• Based on this graphic: http://sulu.io/uploads/media/560x/02/62-Sulu%20System%20Architecture.png?v=1

The content types should also have twig examples
e.g. media_selection: http://docs.sulu.io/en/latest/reference/content-types/media_selection.html

should have a example how to use the displayOptions (view parameters).

• Introduction text
• Summary

• Seperation of concerns

I tried adding a new webspace. Didn't see any reference to sulu:webspaces:init in the docs.

Fortunately it was mentioned on Slack before I ran to it but an Adding a New Webspace page would be a useful addition to the docs.

1. Create file as per existing instructions.
2. Clear cache
3. Run sulu:webspaces:init
4. ...

• What is a webspace?
• Why do we need it?

The navigation contexts, which are part of the Webspace XML file, should be explained somewhere in the documentation.

How to create a page extension?
Like SEO and Excerpt & Categories.

Currently we don't have any instructions on how to configure a webserver for usage with Sulu. I guess there should be some explained configuration files for apache and nginx.

sulu/sulu#451 (comment)

We should adopt the standards used by Symfony documentors:

http://symfony.com/doc/current/contributing/documentation/standards.html

For example no lines exeeding 85 characters, line breaks after a title etc.

• Make table look better.

• What are contacts in Sulu?
• What are organizations?
• How are they configured?
• How are they edited?
• How could they be used in a Twig Template?

• What is a template?

We get a lot of questions on how to extend the Admin interface. I think we should add some tutorials to the cookbook.

We should start with the basic possibilities, covering the Admin UI

• What Events do exist?
• When are they fired?

• Add the structure.

Add the basic stuff

• Introduction
• outlook

Add documentation how to implement the template that the preview can work.

Block is a very important feature of the templates and should be an own section in http://docs.sulu.io/en/latest/book/creating-a-basic-website/adding-a-template.html site.
Currently its complete missing.

Tutorial showing how to create a Sulu extension using the GeneratorBundle.

It would be great if we could behat test the docs #1

This should go into the sub heading http://docs.sulu.io/en/latest/book/creating-a-basic-website/adding-a-template.html#create-the-data-connection

Explain which variables there are to use, and how to use the rdfa tags to support the preview in Sulu.

This may be related to #51 as it sounds like the templates themselves need to also be compatible with the preview?

How to add a custom menu Entry?
What could happen in there?

Similar to contacts or Assets.

• Add installation links.

I would really like to test out my idea of functional testing documentation with Sulu. (https://github.com/dantleech/sphinx-behat)

A prerequisite for this would be to make the documentations in RestructuredText format and use Sphinx (as with the symfony, doctrine and CMF docs).

A start might be to implement the installation instructions.

Functional testing the documentation would provide an additional smoke test and ensure that the documentation is always "working".

It would be nice to have a documentation about how to use the content events (ContentNodeOrderEvent, ContentNodeEvent, ContentNodeDeleteEvent)

http://docs.sulu.io/en/latest/book/creating-a-basic-website/setup-a-webspace.html#navigation seems to be too less to understand this concept correctly.

Old deprecated documentation https://github.com/sulu-io/docs/blob/master/developer-documentation/300-webspaces/templates.md

Maybe part of Creating a Twig Template?

See sulu/sulu-standard#572

• Naming convention (currently bug in SULU) no dot in key or filename
• mention ENV variable in .htacess or vhost-file

• app/website => web/website
• Need to disable cookies

unset req.http.Cookie

And not disable for /admin.

• Where
• Why
• What

• What are localizations in Sulu?
• What problems do they solve?
• How are they configured?
• How are they edited?
• How are they implemented?

• Typical requirements for a Sulu based project.
• Skills of a developer who develops with Sulu.

In the xml templates you can add a tag named sulu.search.field, so that it will be indexed by the MassiveSearchBundle. This should be explained in the documentation.

Update the Introduction Text.

Add a description about how to paginate the smart-content result in twig http://docs.sulu.io/en/latest/book/creating-a-basic-website/using-smart-content.html

We should add the spelling checker, e.g.

symfony-cmf/symfony-cmf-docs#631

• What is smart content?
• How is it configured in the template?
• How is it used in a Twig template?

There should be a little introduction and an overview on every single welcome screen.

• What is it?
• Dashboard
• Contacts (People/Organizations)
• Assets
• Settings (User Roles, Categories, Tags, Cache)
• Global Content
• Webspaces

How is the Content in Sulu structured?
Where is it saved?
How is it saved?

http://docs.sulu.io/en/latest/developer/create-bundle/views-tabs.html

I think it would be nice if there is a reference to the "using tab navigation" to add tabs in the sulu ui: http://docs.sulu.io/en/latest/cookbook/using-tab-navigation.html

We should define in the docs how the environment of a Sulu installation can be changed, and also define some best practices.

• Introduction and summary.