[Bug] [PHP] Bad role for documentation - Githubissues

apache / skywalking

APM, Application Performance Monitoring System

https://skywalking.apache.org/

Apache License 2.0

23.86k stars 6.52k forks source link

[Bug] [PHP] Bad role for documentation #9753

Closed remicollet closed 2 years ago

remicollet commented 2 years ago

Search before asking

[X] I had searched in the issues and found no similar issues.

Apache SkyWalking Component

CLI (apache/skywalking-cli)

What happened

In package.xml documentation have role="src" instead of expected role="doc"

What you expected to happen

role="doc" for NOTICE, README.md, LICENSE

How to reproduce

pecl install ...

Anything else

There is no component in above dropdown for the PHP agent

Are you willing to submit PR?

[ ] Yes I am willing to submit a PR!

Code of Conduct

[X] I agree to follow this project's Code of Conduct

heyanlong commented 2 years ago

@remicollet Thanks you for report the bug, I'll fix it now

jmjoy commented 2 years ago

README.md will be compiled into the .so because of https://github.com/apache/skywalking-php/blob/737b4f65824bb4939faa3e9452b83c73bf5ddfe8/src/lib.rs#L18 , others can be used as docs.

heyanlong commented 2 years ago

I fixed it, .md, NOTICE, and LICENSE will be set to doc https://github.com/apache/skywalking-php/pull/16

jmjoy commented 2 years ago

https://github.com/apache/skywalking-php/pull/16 Merged.