]> granicus.if.org Git - php/commitdiff
Move README files to a dedicated docs directory
authorPeter Kokot <peterkokot@gmail.com>
Wed, 27 Mar 2019 19:51:45 +0000 (20:51 +0100)
committerPeter Kokot <peterkokot@gmail.com>
Sat, 30 Mar 2019 18:38:34 +0000 (19:38 +0100)
The new dedicated docs directory has been introduced after a discussion
on GitHub[1].

Main issue it is addressing is the reduction of too many README files in
the project root directory. The new directory is dedicated for notes and
quick documentation files that either can't be put in the manual or wiki
pages or that relate to the php-src repository specifically and need to
live together with the source code.

Also the `docs` directory is by GitHub used for some repository
configuration files such as pull request templates, and contributing
documentation helper files that are integrated in the interface.

[1]: https://github.com/php/php-src/pull/3988

README.md
docs/input-filter.md [moved from README.input_filter with 100% similarity]
docs/mailinglist-rules.md [moved from README.MAILINGLIST_RULES with 100% similarity]
docs/output-api.md [moved from README.NEW-OUTPUT-API with 100% similarity]
docs/parameter-parsing-api.md [moved from README.PARAMETER_PARSING_API with 100% similarity]
docs/release-process.md [moved from README.RELEASE_PROCESS with 100% similarity]
docs/self-contained-extensions.md [moved from README.SELF-CONTAINED-EXTENSIONS with 100% similarity]
docs/streams.md [moved from README.STREAMS with 100% similarity]
docs/unix-build-system.md [moved from README.UNIX-BUILD-SYSTEM with 100% similarity]

index 45706d24256227e44e3179bf0e8620fd5f91a873..09dde4fdb863427bef1ece47271892d50e425f06 100644 (file)
--- a/README.md
+++ b/README.md
@@ -94,8 +94,8 @@ contribute:
 
 - [Contributing to PHP](/CONTRIBUTING.md)
 - [PHP coding standards](/CODING_STANDARDS)
-- [Mailinglist rules](/README.MAILINGLIST_RULES)
-- [PHP release process](/README.RELEASE_PROCESS)
+- [Mailinglist rules](/docs/mailinglist-rules.md)
+- [PHP release process](/docs/release-process.md)
 
 ## Testing
 
similarity index 100%
rename from README.input_filter
rename to docs/input-filter.md
similarity index 100%
rename from README.NEW-OUTPUT-API
rename to docs/output-api.md
similarity index 100%
rename from README.STREAMS
rename to docs/streams.md