8000 Updated the example used to explain page creation by javiereguiluz · Pull Request #3888 · symfony/symfony-docs · GitHub
[go: up one dir, main page]

Skip to content

Updated the example used to explain page creation #3888

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

Merged
merged 4 commits into from
Aug 16, 2014
Merged

Updated the example used to explain page creation #3888

merged 4 commits into from
Aug 16, 2014

Conversation

javiereguiluz
Copy link
Member
Q A
Doc fix? yes
New docs? no
Applies to 2.3+
Fixed tickets #3576

To avoid confusions with the AcmeDemoBundle, this chapter now uses a "Random Number" example instead of the classic "Hello World".

you're finished, the user will be able to get a personal greeting (e.g. "Hello Symfony")
by going to the following URL:
Instead of building the classic "Hello World!" application, this chapter develops
an appllication that generates random numbers . When you're finished, the user
Copy link
Member

Choose a reason for hiding this comment

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

It's a bit strange to start a section with "Instead". Let's just say "In this chapter, you'll develop an application that can generate random numbers. When you're [...]"

@wouterj
Copy link
Member
wouterj commented May 29, 2014

Create example!

by going to the following URL:
In this chapter, you'll develop an application that can generate random numbers.
When you're finished, the user will be able to get a random number between ``1``
and the upper limit set with the URL:
Copy link
Member

Choose a reason for hiding this comment

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

Isn't [...] set by the URL correct?

@javiereguiluz
Copy link
Member Author

@xabbuh you are absolutely right! AcmeDemoBundle is the best name because it's generic (doesn't imply and/or constraint anything) and it's easier for the reader because it's used elsewhere.

@weaverryan
Copy link
Member

I like it! But, won't using AcmeDemoBundle be a conflict if they already have that bundle in their project? What do you think about that Javier?

@xabbuh
Copy link
Member
xabbuh commented Jun 7, 2014

That's a good point, Ryan. Is there a better name to use? Would be great to have one unique name throughout the docs.

@weaverryan
Copy link
Member

:) I would like to call it DemoBundle - I think having the vendor prefix for user-land bundles is a bad idea. But that's a conversation for later. We could alternatively add a note that says "You may already have an AcmeDemoBundle, etc etc" - and just let them know that if they already have this bundle, just use it!

@wouterj
Copy link
Member
wouterj commented Jun 7, 2014

Well, to be honest. I don't see the extra value of having the same bundle for all documentation. Using different bundles means we can use different examples and using more examples gives people a better overview of what Symfony is capable of.

But let's move that discussion to somewhere else :)

@weaverryan
Copy link
Member

Actually, +1 to that Wouter

@javiereguiluz
Copy link
Member Author

After reading this discussion, I'm a bit confused about the bundle name. So please, tell me which name do you want to use for this example and I'll change it:

  • AcmeDemoBundle
  • DemoBundle
  • NumberBundle
  • AcmeNumberBundle
  • AcmeWebsiteBundle
  • WebsiteBundle

@wouterj
Copy link
Member
wouterj commented Jun 9, 2014

Let's use AcmeDemoBundle here (including the "You may already have an AcmeDemoBundle, etc etc" proposal of Ryan if you think it's usefull).

We can discuss later if we want to include the vendor name or not, etc.

@weaverryan
Copy link
Member

+1

@wouterj
Copy link
Member
wouterj commented Aug 15, 2014

ping @weaverryan

@weaverryan
Copy link
Member

Thanks everyone!

@weaverryan weaverryan merged commit 1350e6c into symfony:2.3 Aug 16, 2014
weaverryan added a commit that referenced this pull request Aug 16, 2014
…ereguiluz)

This PR was merged into the 2.3 branch.

Discussion
----------

Updated the example used to explain page creation

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | 2.3+
| Fixed tickets | #3576

To avoid confusions with the AcmeDemoBundle, this chapter now uses a "Random Number" example instead of the classic "Hello World".

Commits
-------

1350e6c Added a note for users with an existing AcmeDemoBundle
1c01b49 Replaced "AcmeWebsiteBundle" by "AcmeDemoBundle"
2345a0e Reworded the beginning of one section
575bc9a Replaced the "Hello World" example to avoid confusion with AcmeDemoBundle
weaverryan added a commit that referenced this pull request Aug 16, 2014
We're just showing what *is* actually there, not telling them to change anything.
weaverryan added a commit that referenced this pull request Aug 16, 2014
* 2.3: (35 commits)
  use relative path to page
  fix xml to specify a method
  replaced old way of specifying http method by the new one
  Fixing a mistake
  Fix use mistakes.
  [#3944] Tiny addition to mention multiple connections
  Update dbal.rst
  [#3888] Changing base template title back
  [Components] consistent & complete config examples
  Fixed typos
  Added link to JSFiddle example
  some minor improvements
  describe the usage of the RegisterListenersPass
  Update deployment-tools.rst
  Rewrote Extension & Configuration docs
  add order of translation formats
  Fix class name in ConsoleTerminateListener example
  [Book] consistent and complete config examples
  added Github teams for the core team
  [book][cache][tip] added cache annotations.
  ...
weaverryan added a commit that referenced this pull request Aug 16, 2014
* 2.4: (38 commits)
  use relative path to page
  fix xml to specify a method
  replaced old way of specifying http method by the new one
  Fixing a mistake
  Fix use mistakes.
  [#3944] Tiny addition to mention multiple connections
  Update dbal.rst
  [#3888] Changing base template title back
  [Components] consistent & complete config examples
  Check for api_key in request
  Update api_key_authentication.rst - POST Method
  Fixed typos
  Added link to JSFiddle example
  some minor improvements
  describe the usage of the RegisterListenersPass
  Update deployment-tools.rst
  Rewrote Extension & Configuration docs
  add order of translation formats
  Fix class name in ConsoleTerminateListener example
  Fixed the code snippets for the expression language functions
  ...
weaverryan added a commit that referenced this pull request Aug 16, 2014
* 2.5: (39 commits)
  use relative path to page
  fix xml to specify a method
  replaced old way of specifying http method by the new one
  Fixing a mistake
  Fix use mistakes.
  [#3944] Tiny addition to mention multiple connections
  Update dbal.rst
  [#3888] Changing base template title back
  [Components] consistent & complete config examples
  Check for api_key in request
  Update api_key_authentication.rst - POST Method
  Fixed typos
  Fixed typos
  Added link to JSFiddle example
  some minor improvements
  describe the usage of the RegisterListenersPass
  Update deployment-tools.rst
  Rewrote Extension & Configuration docs
  add order of translation formats
  Fix class name in ConsoleTerminateListener example
  ...
@xabbuh
Copy link
Member
xabbuh commented Oct 23, 2014

Let's use AcmeDemoBundle here (including the "You may already have an AcmeDemoBundle, etc etc" proposal of Ryan if you think it's usefull).

We can discuss later if we want to include the vendor name or not, etc.

see #4361

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
0