Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Re-write of Page Creation #5386

Merged
merged 9 commits into from
Jun 19, 2015
Merged

Re-write of Page Creation #5386

merged 9 commits into from
Jun 19, 2015

Conversation

weaverryan
Copy link
Member

Q A
Doc fix? yes
New docs? no
Applies to 2.3+
Fixed tickets n/a

Hi guys!

Woh! I'm super excited about this - another step to making Symfony more and more accessible to everyone. The "page creation" chapter should be people's entry point to Symfony (quick tour should be more for advertising I think).

But, when I re-read this chapter - it was terrible (I probably wrote most of it) - way too many long explanations when someone is first starting. It also is one of the last spots to use AcmeDemoBundle.

The goal: let someone read for 10 minutes, get some success/momentum, and link to where to go next (and some other interesting spots, without overwhelming).

A lot was moved to 2 new chapters - bundles and configuration - which I'll re-read soon in the same way.
Right now - bundles.rst and configuration.rst are verbatim of what they were before. So, we don't need to review these, other than to make sure they don't have an abrupt start or end (since they were just sections in the middle of page_creation.rst before.

Some stuff was just removed. A list is here: https://gist.github.com/weaverryan/252f02b3028888b3f5df

Thanks guys!

Every aspect of a feature exists in a bundle and every feature lives in a
bundle.

An application is made up of bundles as defined in the ``registerBundles()``
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of saying "an app is made of bundles defined in registerBundles()`, what about explaining it in reverse: "Bundles used in your applications must be enabled by registering them in the registerBundles() method."

@javiereguiluz
Copy link
Member

@weaverryan this proposal is absolutely brilliant! I couldn't like it more. Amazing!

@weaverryan
Copy link
Member Author

Thanks Javier (and fast!). I've just used all of your suggestions :).

.. _page-creation-bundles:

The Bundle System
-----------------
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

- has to be = and ~ has to be - in this article's titles.

single: Page creation; Example
Suppose you want to create a page - ``/lucky/number`` - that generates a
lucky (well, random) number and prints it. To do that, create a class and
a method inside of it that will be executed when someone goes to ``/lucky/random``::
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lucky/random -> /lucky/number

@weaverryan weaverryan force-pushed the page-creation-appbundle branch from 75a61f9 to be87cff Compare June 19, 2015 16:54
@weaverryan weaverryan merged commit be87cff into 2.3 Jun 19, 2015
weaverryan added a commit that referenced this pull request Jun 19, 2015
This PR was merged into the 2.3 branch.

Discussion
----------

Re-write of Page Creation

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | 2.3+
| Fixed tickets | n/a

Hi guys!

Woh! I'm super excited about this - another step to making Symfony more and more accessible to everyone. The "page creation" chapter should be people's entry point to Symfony (quick tour should be more for advertising I think).

But, when I re-read this chapter - it was terrible (I probably wrote most of it) - way too many long explanations when someone is first starting. It also is one of the last spots to use AcmeDemoBundle.

The goal: let someone read for 10 minutes, get some success/momentum, and link to where to go next (and some other interesting spots, without overwhelming).

A lot was moved to 2 new chapters - bundles and configuration - which I'll re-read soon in the same way.
Right now - `bundles.rst` and `configuration.rst` are verbatim of what they were before. So, we don't need to review these, other than to make sure they don't have an abrupt start or end (since they were just sections in the middle of `page_creation.rst` before.

Some stuff was just removed. A list is here: https://gist.github.com/weaverryan/252f02b3028888b3f5df

Thanks guys!

Commits
-------

be87cff Remoing link to now-gone web section
31c76c6 Fixes thanks to Wouter!
bc33dad removing reference that I removed
53819ad removing duplicate reference
01f52fd Lots of updates thanks to @javiereguiluz!
393e8d8 adding missing reference
aa3cc95 Proofread!
6a66868 Complete rewrite of the page creation chapter to be much shorter
6b6cbc0 WIP
@weaverryan weaverryan deleted the page-creation-appbundle branch June 19, 2015 16:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants