Skip to content

Add missing formats in documentation #2042

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

Closed
wouterj opened this issue Dec 17, 2012 · 9 comments
Closed

Add missing formats in documentation #2042

wouterj opened this issue Dec 17, 2012 · 9 comments

Comments

@wouterj
Copy link
Member

wouterj commented Dec 17, 2012

There are a lot of places where some format is missing. I have created a list of them in this gist: https://gist.github.com/4322564

The formats in Symfony2 are:

  • yaml, xml and php for configuration files (or service files, routing files, ect.)
  • yaml, xml, php and annotation for validation
  • yaml, xml, annotation for doctrine

One other thing which is related to this: I suggest to change the order in examples showing service configuration files. It is more common to use XML for that.

@ricardclau
Copy link
Contributor

If you want, I can help in filling these missing formats

Should I start lowest in the list?

@wouterj
Copy link
Member Author

wouterj commented Feb 5, 2013

@ricardclau I have done the complete reference at this moment. You can take a look at the cookbook or book sections. Just let us know on which chapters you are going to work, so we don't do something twice.

@ricardclau
Copy link
Contributor

Ok! Good to know as I was going to start with the reference :)

Looking at the cookbooks... I guess I could take most of them except maybe Symfony1 where I have no experience

How do you want to do it? All at once? Picking some sections each one of us? Perhaps we can share a branch to merge all at once?

I can start with (and not picking more of them as I don't know exactly how much time I will have during the week):

templating/global_variables
xml and PHP config: L10, L33;
PHP templating: L20;

logging/monolog
PHP config: L51 ( 'Using several handlers' ), L129 ( 'Changing the formatter' );
xml and PHP config: L215 ( 'Using several handlers' );

logging/monolog_email
xml and PHP config: L13, L86;

web_services/php_soap_extension
PHP config: L57;

Is that ok?

@wouterj
Copy link
Member Author

wouterj commented Feb 5, 2013

How do you want to do it? All at once? Picking some sections each one of us? Perhaps we can share a branch to merge all at once?

I think the best option is to split the work. I think sharing a branch is a great idea! Just base your PRs on WouterJ/symfony-docs@add_missing_formats (for the 2.0 branch) and WouterJ/symfony-docs@add_missing_formats_21 (for the 2.1 branch) and I will make a Pull Request if we finished the cookbook.

@ricardclau
Copy link
Contributor

Ok, I'll do so, keep in touch!

@wouterj
Copy link
Member Author

wouterj commented Feb 5, 2013

Great, thanks for your nice work! I have updated the document to make sure others don't begin with this.

@ricardclau
Copy link
Contributor

Hi

I am trying to PR to your branches but your fork does not appear in Github combo in the PR dialog. The weird thing is that there are hundreds of other people appearing where I can PR (basically everyone that has ever done a PR to Symfony-docs). Do you know what might be happening?

@wouterj
Copy link
Member Author

wouterj commented Feb 5, 2013

@ricardclau it seems just another bug of github... However you can fix it.

The pull request url should look like this:
https://github.com/ricardclau/symfony-docs/pull/new/WouterJ:add_missing_formats...ricardclau:YOUR_BRANCH

This forces github to base the pull request on my branch :)

@ricardclau
Copy link
Contributor

Oh url hacks :)

First draft done, on my way for PHP config in Monolog

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

No branches or pull requests

2 participants