8000 Update Quick Tour for Removal of Welcome Page in 2.7 · Issue #5353 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

Update Quick Tour for Removal of Welcome Page in 2.7 #5353

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.

Sign up for GitHub

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

Jump to bottom
Closed
BT643 opened this issue Jun 2, 2015 · 14 comments
Closed

Update Quick Tour for Removal of Welcome Page in 2.7 #5353

BT643 opened this issue Jun 2, 2015 · 14 comments
Labels
bug Waiting feedback

Comments

@BT643
Copy link
Contributor
BT643 commented Jun 2, 2015

It seems the "Welcome!" page has been removed as of 2.7 so the quick tour documentation is now misleading / wrong.

https://symfony.com/doc/current/quick_tour/the_big_picture.html#running-symfony

It tells you to go to http://localhost:8000 to see the welcome page but this just brings up an error as there is now no route defined for /.

I was going to update the documentation but wasn't sure what to put there instead? Just tell the user to go straight to /app/example and see the "Homepage." text I guess would be the best option?
@michaelperrin
Copy link
Contributor

This can be indeed misleading for new comers. The whole Quick Tour should be rewritten with either a simple step by step new app (creating the controller / routing / template) or with the new demo app (http://symfony.com/blog/introducing-the-symfony-demo-application).

I would prefer the first solution, as Symfony is installed by developers who want to start a new app and see how things work.

@xabbuh xabbuh mentioned this issue Jun 26, 2015
Closed
@cuthbert19
Copy link

I am indeed a newcomer and I was at first very disappointed, while following the quick tour, of not being able to get it to work right after installation. I second michaelperrin proposal, the demo application seems to me as being too complex for a q 8000 uick tour, while I appreciated the "10 minutes by 10 minutes" lesson of the current approach.

@wouterj
Copy link
Member
wouterj commented Jun 26, 2015

#5416 is now merged, which fixes the URL. The screenshot has already been updated in another PR. This means that this issue is now completely fixed.

Rewriting the complete Quick Tour, now we got a demo application, is a very good question. We were discussing this internally, but I don't know about the current state of this. Anyway, it's better to have a dedicated issue for this :)

@wouterj wouterj closed this as completed Jun 26, 2015
@xabbuh xabbuh mentioned this issue Jun 28, 2015
Merged
@xabbuh
Copy link
Member
xabbuh commented Jun 28, 2015

It looks like the changes from #5400 and #5416 are not sufficient enough. Firstly, the changes were only merged in the 2.7 branch while the Symfony Standard Edition has also been updated for older maintained versions. Secondly, there were some other wrong URL and text references. I proposed updates for these things in #5461.

@xabbuh xabbuh reopened this Jun 28, 2015
@BT643
Copy link
Contributor Author
BT643 commented Jul 5, 2015
8000

There's an issue opened on StackOverflow as little as 9 hours ago which show this is still an "issue" also:

http://stackoverflow.com/questions/31227664/installing-symfony-2-on-windows

@xabbuh
Copy link
Member
xabbuh commented Jul 7, 2015

@BT643 These issue would be tackled by #5461, right?

@BT643
Copy link
Contributor Author
BT643 commented Jul 7, 2015

@xabbuh It would certainly help, although I imagine there would still be some people who would start the built in server from the console which tells you to visit / and wonder why they're getting an "error page".

If that is all properly explained in the quick tour it should resolve it.

@xabbuh
Copy link
Member
xabbuh commented Jul 7, 2015

@BT643 Do you have an idea how we could make this more clear?

@BT643
Copy link
Contributor Author
BT643 commented Jul 7, 2015

When you run the command: symfony new testing123 you get:

* Run your application:
        1. Execute the php app/console server:run command.
        2. Browse to the http://localhost:8000 URL.

People may follow this and immediately wonder why it's not working. Yes, they will see the following if they carry on reading, but may still wonder why / is not working as it isn't explained.

Open your browser and access the http://localhost:8000/app/example URL to see the welcome page of Symfony:

A possible solution would just be to modify the note below it slightly:

Instead of the welcome page, you may see a blank page or an error page. This is caused by a directory permission misconfiguration. There are several possible solutions depending on your operating system. All of them are explained in the Setting up Permissions section of the official book. Please note - You will receive a 404 if you visit http://localhost:8000/ as no route has been defined here yet.

(the bold section is just to show what I changed, rather than it being bold in the docs)

Obviously this is all blindingly obvious when you already know it, but I'm just looking from a brand new user's perspective.

@javiereguiluz
Copy link
Member

I agree with @BT643. I consider this a "bug" and a high priority one. The first thing you see about Symfony shouldn't be an error. This is WTF for experienced developers and totally unacceptable for newcomers.

Sadly I don't know what to do. What could we do to improve user experience here? I need ideas. Thanks! / cc @wouterj @xabbuh @weaverryan

@xabbuh
Copy link
Member
xabbuh commented Jul 7, 2015

Maybe we should update the Standard Edition to include a redirect from / to /app/example? I am not sure if there is something that we could write in the docs to make this more clear (and actually having an application that provides things under /app/example, but returns a 404 error at / looks weird to me).

@javiereguiluz
Copy link
Member

In an ideal world, when you access the / URL of a freshly installed Symfony project, you would see a simple but beautiful Welcome Page. This page shouldn't pollute your application, so it shouldn't be generated with a custom route or controller or template. Is this even possible? Can we make this check in the exception listener of the dev environment and display the Welcome page if there is no custom route defined for that URL?

@xabbuh
Copy link
Member
xabbuh commented Jul 8, 2015

Technically that would be possible. Though I am not sure if it really fits best there.

weaverryan added a commit that referenced this issue Jul 16, 2015
@weaverryan
bug #5461 Rework quick tour big picture (smatejic, DQNEO, xabbuh)
f7ccb0c 
This PR was merged into the 2.3 branch.

Discussion
----------

Rework quick tour big picture

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | all
| Fixed tickets | #5353

Commits
-------

d4ea145 rework the quick tour's big picture
2e89aed fix for Symfony 2.7
377c6a7 Fix after install URL and new photo since AcmeDemoBundle is not part of 2.7
@weaverryan
Copy link
Member

I actually just messaged @javiereguiluz about this. I'm strongly in favor of a route+controller+template at the / URL of the standard edition. I don't think this pollutes the application at all. To the contrary, beginners will have a starting point they can start tweaking. For experienced devs, it's just one controller and one templates.

I merged #5461 so the quick tour is up to date with how things are now. Hopefully we can update that again soon to show some elegant "homepage".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Waiting feedback
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
7 participants
@javiereguiluz @weaverryan @michaelperrin @wouterj @xabbuh @BT643 @cuthbert19
0