Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

[Config] [WIP] Add doc links support in Config component #21081

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 3 commits into from
Closed

[Config] [WIP] Add doc links support in Config component #21081

wants to merge 3 commits into from

Conversation

maidmaid
Copy link
Contributor

@maidmaid maidmaid commented Dec 28, 2016 •
edited
Loading

Q A
Branch? master
Bug fix? no
New feature? yes
BC breaks? no
Deprecations? no
Tests pass? yes
Fixed tickets n/a
License MIT
Doc PR n/a

Hello,

In the same idea that #21046, I propose to add support of documentation links in Config component: each node in a config has own documentation link (for example, framework.secret config has this doc). When we run config:dump-reference command, it would be very usefull to show these doc links. Furthermore, in this way, the integration of the support of doc links in the IDE can be imagined (cf Haehnchen/idea-php-symfony2-plugin#876).

Result by running php bin/console config:dump-reference framework --with-doc:

framework:
    secret: ~ # Doc: https://symfony.com/doc/3.2/reference/configuration/framework.html#secret

Configurations done:

  • framework
  • doctrine
  • security
  • assetic
  • swiftmailer
  • twig
  • monolog
  • web_profiler
  • debug

@fabpot fabpot mentioned this pull request Dec 30, 2016
Closed
@nicolas-grekas nicolas-grekas added this to the 3.x milestone Jan 2, 2017
@maidmaid
Copy link
Contributor Author

Is it possible to standardize the documentation anchors (#) by always prefixing them with the parent config? This is true only in case of conflict.

For example, for framework.router.type config, current anchor is framework.html#type and should be framework.html#router-type. In this way, the doc link will be ever true, even if an other config uses the same word.

This was referenced Feb 23, 2017
Open
Closed
@jakzal
Copy link
Contributor

jakzal commented Mar 1, 2017

Since #21046 was rejected, what do we do about this one?

@fabpot
Copy link
Member

fabpot commented Mar 1, 2017

I think I'm 👎 as well on this one.

@fabpot fabpot closed this Mar 5, 2017
@nicolas-grekas nicolas-grekas modified the milestone: 3.x Mar 24, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
Config Feature Status: Needs Review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@maidmaid @jakzal @fabpot @nicolas-grekas @carsonbot
Morty Proxy This is a proxified and sanitized view of the page, visit original site.