8000 Added a note about permissions in the Quick Tour by javiereguiluz · Pull Request #4070 · symfony/symfony-docs · GitHub
[go: up one dir, main page]

Skip to content

Added a note about permissions in the Quick Tour #4070

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
Jul 31, 2014
Merged

Added a note about permissions in the Quick Tour #4070

merged 4 commits into from
Jul 31, 2014

Conversation

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

Instead of the greeting page, you may see a blank or error page. This is
caused by a directory permission misconfiguration. There are several possible
solutions depending on your operating system. Check out them all in the
:doc:`installation chapter </book/installation.html#book-installation-permissions>`
Copy link
Member

Choose a reason for hiding this comment

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

this doesn't work. you have to use the ref role to link to specific pointers: :ref:book-installation-permission``

@@ -89,6 +89,13 @@ main concepts. Go to the following URL to be greeted by Symfony2 (replace
.. image:: /images/quick_tour/hello_fabien.png
:align: center

.. note::

Instead of the greeting page, you may see a blank or error page. This is
Copy link
Member

Choose a reason for hiding this comment

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

I would be more verbose: "[...] a blank page or an error page." I think that's more readable and sounds better.

@javiereguiluz
Copy link
Member Author

I use :ref:book-installation-permissions as recommended, but the Travis build fails with this error:

Warning, treated as error:
/home/travis/build/symfony/symfony-docs/quick_tour/the_big_picture.rst:94: WARNING: undefined label: book-installation-permissions (if the link has no caption the label must precede a section header)

Can someone help me solving this issue? Thanks!

@wouterj
Copy link
Member
wouterj commented Jul 31, 2014

Ah, @javiereguiluz the pointer book-installation-permissions is put here: https://github.com/symfony/symfony-docs/blame/master/book/installation.rst#L215

As you can see, the pointer is not directly followed by a headline. That means Sphinx cannot automatically generate the text for the reference link, as it normaly takes the headline. So in this case, you have to write the text yourself. For instance: :ref:Setting up Permissions ``.

PS: These reference still don't work well with the fixed navbar, see #3974

@weaverryan
Copy link
Member

Thanks Wouter and Javier - it's a nice note, and I like that it came from real use experience. I will also say, that I really hate the permission problem. It's something that trips up begi 8000 nners immediately (unless they're using the built-in web server) and has various, complex solutions depending on your OS. I don't know if there is an actual solution, but any time I see something so basic being so annoying, it makes me want something better :). Thanks!

@weaverryan weaverryan merged commit 141cf5e into symfony:2.3 Jul 31, 2014
weaverryan added a commit that referenced this pull request Jul 31, 2014
…guiluz)

This PR was merged into the 2.3 branch.

Discussion
----------

Added a note about permissions in the Quick Tour

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

Commits
-------

141cf5e Added the missing title for a reference
bed2602 Minor rewording and fixed one reference
93b457e Fixed a wrong documentation reference (thanks @wouterj)
646a00c Added a note about permissions in the Quick Tour
@wouterj
Copy link
Member
wouterj commented Jul 31, 2014

I don't know if there is an actual solution, but any time I see something so basic being so annoying, it makes me want something better :).

Let's create a DX issue and see if we can find a solution :)

@javiereguiluz
Copy link
Member Author

@wouterj are you going to open a DX issue about permissions on Symfony repository?

@wouterj
Copy link
Member
wouterj commented Aug 1, 2014

if you want to do it, feel free to do so. I don't have much time...

@weaverryan
Copy link
Member

Got it! symfony/symfony#11563

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants
0