NotificationsYou must be signed in to change notification settings
Fork9.7k
Star30.8k

[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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Closed

maidmaid wants to merge3 commits intosymfony:masterfrommaidmaid:confighelp

Closed

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

maidmaid wants to merge3 commits intosymfony:masterfrommaidmaid:confighelp

Conversation

Copy link

Contributor

maidmaid commentedDec 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 thisdoc). When we runconfig: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 (cfHaehnchen/idea-php-symfony2-plugin#876).

Result by runningphp 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

carsonbot added Status: Needs Review Config Feature labels

Dec 28, 2016

fabpot mentioned this pull request

Dec 30, 2016

[WebProfilerBundle] [WIP] Add help in Web Profiler#21046

Closed

nicolas-grekas added this to the3.x milestone

Jan 2, 2017

maidmaid force-pushed theconfighelp branch fromcf78825 to50ec3bbCompare

February 22, 2017 09:13

maidmaid added2 commits

February 22, 2017 23:16

Add framework.secret doc

de6fdff

Update docs of framework config

6e3ad28

maidmaid force-pushed theconfighelp branch from50ec3bb to6e3ad28Compare

February 22, 2017 22:30

Copy link

ContributorAuthor

maidmaid commentedFeb 22, 2017

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

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