Skip to content
This repository has been archived by the owner on Jan 29, 2020. It is now read-only.

Add the link to the docs in the composer.json #24

Closed
wants to merge 1 commit into from

Conversation

stof
Copy link

@stof stof commented May 11, 2017

The support section of the composer.json allows to provide info about several support channels (see https://getcomposer.org/doc/04-schema.md#support for the full list)

As the docs are available online, I'm adding the link here, allowing automated tools to benefit from the info. for instance, Packagist displays a link to the documentation when it knows it (sreenshot is for a different package, as zend-escaper will obviously not have this link yet as the PR is not merged):
packagist_doc

I'm not adding the issue tracker here, because composer already adds it automatically for github repositories (when calling the API, it checks whether issues are enabled on the repo, and then injects the link to the issue tracker in the support section if there is none provided). The automated injection is better, as it is updated automatically if you rename the github repo.
If you have extra support channels (IRC, mailing-list, forum, etc...), I will let you improve the metadata further.

@stof
Copy link
Author

stof commented May 11, 2017

Note that you may want to perform the same for all packages (probably automating it once you determine the list you want). But I won't do it myself.
I contributed this improvement for this package while linking to it for other people.

@froschdesign
Copy link
Member

@stof
The link is wrong. Fixed with 9f1c109

Thanks!

@stof
Copy link
Author

stof commented May 11, 2017

the link is the one which is in the readme. If it is wrong, please fix it there too.

@stof stof deleted the patch-1 branch May 11, 2017 14:20
@froschdesign
Copy link
Member

@stof
Do not worry, it's on my plan.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants