Skip to content

Fully document monolog bundle configuration #2862

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
3 tasks done
Seldaek opened this issue Jul 29, 2013 · 12 comments
Closed
3 tasks done

Fully document monolog bundle configuration #2862

Seldaek opened this issue Jul 29, 2013 · 12 comments
Labels
actionable Clear and specific issues ready for anyone to take them. good first issue Ideal for your first contribution! (some Symfony experience may be required) hasPR A Pull Request has already been submitted for this issue. Logger

Comments

@Seldaek
Copy link
Member

Seldaek commented Jul 29, 2013

Here are a few things that got added today that would be nice to find in the docs I think for discoverability:

That is all, thanks!

@wouterj
Copy link
Member

wouterj commented Jul 30, 2013

I'll fix (1) today.

@wouterj
Copy link
Member

wouterj commented Jul 30, 2013

@Seldaek to which symfony version does this apply?

@stof
Copy link
Member

stof commented Jul 30, 2013

@wouterj MonologBundle is not released in sync with Symfony anymore. MonologBundle 2.4 has been released today with new features compatible with Symfony 2.3+

@wouterj
Copy link
Member

wouterj commented Jul 30, 2013

@stof thanks! So, we need to document this in 2.3+?

@stof
Copy link
Member

stof commented Jul 30, 2013

yes

@weaverryan
Copy link
Member

For (1), I don't think we've done this yet, but how about just linking to the PHP docs from the config reference section? I'd like to not duplicate all of these little details. For more complex handlers, we could additionally include an example.

@xabbuh
Copy link
Member

xabbuh commented Nov 28, 2013

For (1), I don't think we've done this yet, but how about just linking to the PHP docs from the config reference section? I'd like to not duplicate all of these little details. For more complex handlers, we could additionally include an example.

I don't see anything wrong with this. I guess we use something like this in the documentation of the HTTP status code constants, don't we?

@gondo
Copy link
Contributor

gondo commented May 7, 2014

what about documenting activation_strategy as well?
i could not find any doc/cookbook for it

@weaverryan
Copy link
Member

I didn't even know about activation_strategy :) (https://github.com/symfony/MonologBundle/blob/master/DependencyInjection/Configuration.php#L72).

Yes, I think we should just add a link from our reference section to the GitHub source code for the above-linked Configuration class. That would go a long way to helping people find handlers and configuration options that they probably don't know exist. The docs above the Configuration class are really great.

@wouterj wouterj added the good first issue Ideal for your first contribution! (some Symfony experience may be required) label Apr 30, 2015
@javiereguiluz
Copy link
Member

It's been two years since this issue was opened. I think it's time to close it as "won't fix". Besides, I don't see the point of duplicating the information that is already included in the PHPdoc. And if we really want to put that information in a real documentation, don't you think it should be included in the Monolog doc and not in Symfony doc or Monolog bundle doc?

@Seldaek
Copy link
Member Author

Seldaek commented Jun 24, 2015

Well, it doesn't belong in monolog much IMO, at least not yet, maybe in 2.0 if we have option arrays they could map closer to the symfony config.

Anyway what could be a thing is to at least link to the configuration source file from the docs "for more info see there"?

@weaverryan
Copy link
Member

Agree with @Seldaek - this isn't a "wont fix" it's just a "nobody has done it yet" - it's a simple issue - just add a link from the monolog configuration reference to https://github.com/symfony/MonologBundle/blob/master/DependencyInjection/Configuration.php#L24-155 to help people out. I agree @javiereguiluz that there's no reason to duplicate :)

@xabbuh xabbuh added the hasPR A Pull Request has already been submitted for this issue. label Jan 6, 2016
xabbuh added a commit that referenced this issue Jan 10, 2016
This PR was squashed before being merged into the 2.3 branch (closes #6109).

Discussion
----------

add link to Monolog configuration

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

Commits
-------

9fe931e add link to Monolog configuration
@xabbuh xabbuh closed this as completed Jan 10, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actionable Clear and specific issues ready for anyone to take them. good first issue Ideal for your first contribution! (some Symfony experience may be required) hasPR A Pull Request has already been submitted for this issue. Logger
Projects
None yet
Development

No branches or pull requests

7 participants