Skip to content
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

Do not distribute documentation #5488

Merged
merged 1 commit into from Mar 20, 2021
Merged

Conversation

szepeviktor
Copy link
Contributor

With Packagist and GitHub

With Packagist and GitHub
@coveralls
Copy link

Coverage Status

Coverage remained the same at 92.819% when pulling ce0e975 on szepeviktor:patch-1 into d172836 on FriendsOfPHP:3.0.

@SpacePossum
Copy link
Contributor

Thanks for the suggestion!

I think shipping the docs could be handy for people so would like to keep those in. These could be excluded from the phar release, but I'm not sure these are in there.

@szepeviktor
Copy link
Contributor Author

I think shipping the docs could be handy for people

Your right. But those could take up 0.1% of downloads.
e.g. production installations do not need that for sure

I leave it up to you.

@keradus
Copy link
Member

keradus commented Mar 19, 2021

docs are out of phar. i would move them away from composer export too.
if one looks for docs, they can go to repo/page/run describe command

and docs are like 1.3MB

so, it's 1:1 between core team for now.
@julienfalque @kubawerlos @localheinz , any opinion?

@SpacePossum
Copy link
Contributor

I'm +0, happy to go either direction

@szepeviktor
Copy link
Contributor Author

I'm glad that you are not -0

@kubawerlos
Copy link
Contributor

I'm for removing the docs from dist, but isn't breaking links in README.rst a problem?

@keradus
Copy link
Member

keradus commented Mar 20, 2021

I'm eager to take that risk and see how many folks would complain, if any

@keradus
Copy link
Member

keradus commented Mar 20, 2021

I prepared PHP-CS-Fixer/PHP-CS-Fixer.github.io#5 to unblock this PR

@keradus keradus added this to the 2.18.4 milestone Mar 20, 2021
@keradus
Copy link
Member

keradus commented Mar 20, 2021

Thank you @szepeviktor.

@keradus keradus merged commit 66a19cb into PHP-CS-Fixer:3.0 Mar 20, 2021
@keradus keradus modified the milestones: 2.18.4, 3.0.0 Mar 20, 2021
@szepeviktor szepeviktor deleted the patch-1 branch March 20, 2021 16:50
@szepeviktor
Copy link
Contributor Author

You're welcome.

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

Successfully merging this pull request may close these issues.

None yet

5 participants