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

[Best Practices] update best practices index #4352

Merged
merged 1 commit into from
Nov 10, 2014

Conversation

xabbuh
Copy link
Member

@xabbuh xabbuh commented Oct 20, 2014

Q A
Doc fix? yes
New docs? no
Applies to all
Fixed tickets

This way, the table of contents on the index page has only one level
like every other index in the documentation.

@wouterj
Copy link
Member

wouterj commented Oct 26, 2014

We can also simply add :maxdepth: 1, the result will be equal, no?

@xabbuh
Copy link
Member Author

xabbuh commented Oct 26, 2014

That should probably do the same. But this is the way we have it in the other parts of the documentation. And I think it's easier to understand for newcomers of we keep it consistent.

@xabbuh
Copy link
Member Author

xabbuh commented Nov 1, 2014

@wouterj @weaverryan What do you think?

@@ -14,3 +15,5 @@ Official Symfony Best Practices
security
web-assets
tests

.. include:: map.rst.inc
Copy link
Member

Choose a reason for hiding this comment

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

Everywhere else, this path is absolute. I'm not sure if it'll matter, but we might as well be absolute here too to avoid issues.

Copy link
Member Author

Choose a reason for hiding this comment

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

Of course, you're right.

This way, the table of contents on the index page has only one level
like every other index in the documentation.
@weaverryan
Copy link
Member

Thanks Christian!

@weaverryan weaverryan merged commit facea46 into symfony:2.3 Nov 10, 2014
weaverryan added a commit that referenced this pull request Nov 10, 2014
This PR was merged into the 2.3 branch.

Discussion
----------

[Best Practices] update best practices index

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

This way, the table of contents on the index page has only one level
like every other index in the documentation.

Commits
-------

facea46 update best practices index
@xabbuh xabbuh deleted the best-practices-index branch November 10, 2014 15:45
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.

3 participants