Skip to content

Switched the documentation from Markdown to ReStructuredText #1717

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

Conversation

javiereguiluz
Copy link

This is one of the steps defined in the "Revamp Documentation Roadmap" defined in #1577

Moreover, this change is needed to integrate as soon as possible the FOSUserBundle documentation on symfony.com, where it'll receive a lot more exposure and, hopefully, will increase the doc contributors.

stof and others added 30 commits June 10, 2013 06:18
consolidate doctrine listeners and move to Doctrine directory
Version 5.0.0 of SwiftMailer has been released, which is a non-breaking change - so modifying the require-dev specification to allow <6.0.
updated swiftmailer/swiftmailer version specification
fix on resetting e-mail. subject and message were missing, there was only e-mail instead, and it didn't work
added diacritices and validation translation
Update FOSUserBundle.ro.yml and added validators.ro.yml
Updated to new definition validation minLength, maxLength => Length
Update wrong comment
Is the format is missing 

InvalidArgumentException: Template name "MktUserBundle:Registration:email.twig" is not valid (format is "bundle:section:template.format.engine")
The format is required by FrameworkBundle
With this PR, globals defined variables aren't available on email twig templates.
Changed use of prependClientTransformer to addViewTransformer.
@wouterj
Copy link

wouterj commented Jan 11, 2015

I did a very quick review (I tried to stick to formatting things only).

@javiereguiluz
Copy link
Author

@wouterj I've added a hidden TOC to avoid Sphinx problems (see javiereguiluz@70c20da) Is this enough to correctly build this documentation?

@wouterj
Copy link

wouterj commented Jan 16, 2015

@javiereguiluz yes. But why not using the TOC to provide the list of next articles?

@javiereguiluz
Copy link
Author

@wouterj there is almost no bundle using RST for its documentation so I looked at one of the few that did: JMSSecurityExtraBundle uses the trick of a hidden TOC: https://raw.githubusercontent.com/schmittjoh/JMSSecurityExtraBundle/master/Resources/doc/index.rst

@wouterj
Copy link

wouterj commented Jan 16, 2015

@javiereguiluz a TOC is just a list of files (the files that are listed in TOC), using their titles. Exactly what you are now doing by manually creating the list.

In Sphinx, all files have to be part of some TOC. Since you don't always want to create a TOC, there is a :hidden: option. However, in this case we want to show the TOC, so why not using it? :)

@stof
Copy link
Member

stof commented Jan 18, 2015

@javiereguiluz can you answer about the way you suggest dealing with the 1.3.x => master merge ?

wouterj and others added 3 commits January 19, 2015 12:22
This PR was squashed before being merged into the 2.0.x-dev branch (closes FriendsOfSymfony#1373).

Discussion
----------

Added basic XML Support

I'm not so sure about the namespace, if you can come up with a different (better) one, I'll change it.

Commits
-------

7c220cf Added basic XML Support
Conflicts:
	Resources/doc/groups.md
@stof
Copy link
Member

stof commented Jan 19, 2015

@javiereguiluz I also merged #1724 which impacts the doc, thus creating a conflict with your conversion. Sorry about that. Can you reapply the change in your rST version when rebasing ?

stof added 4 commits January 19, 2015 14:42
…ntosik)

This PR was merged into the 2.0.x-dev branch.

Discussion
----------

Update configuration_reference.md

add use_flash_notifications

Commits
-------

d3a9f4e Update configuration_reference.md
This PR was merged into the 2.0.x-dev branch.

Discussion
----------

Doctrine xml config

Commits
-------

0d7aa04 Doctrine xml config
@stof
Copy link
Member

stof commented Jan 26, 2015

@javiereguiluz ping

@javiereguiluz
Copy link
Author

Closing this PR because I was trapped in "Git hell" and I prefer to create a new and clean PR: #1739

@stof
Copy link
Member

stof commented Jan 27, 2015

It looks like you rebased onto master instead of rebasing onto 1.3.x

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.