From 8346b4c9f149c1a3d4e0631007e71bbbebd0b87d Mon Sep 17 00:00:00 2001 From: Peter Kokot Date: Wed, 27 Mar 2019 20:51:45 +0100 Subject: [PATCH] Move README files to a dedicated docs directory 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 | 4 ++-- README.input_filter => docs/input-filter.md | 0 README.MAILINGLIST_RULES => docs/mailinglist-rules.md | 0 README.NEW-OUTPUT-API => docs/output-api.md | 0 README.PARAMETER_PARSING_API => docs/parameter-parsing-api.md | 0 README.RELEASE_PROCESS => docs/release-process.md | 0 .../self-contained-extensions.md | 0 README.STREAMS => docs/streams.md | 0 README.UNIX-BUILD-SYSTEM => docs/unix-build-system.md | 0 9 files changed, 2 insertions(+), 2 deletions(-) rename README.input_filter => docs/input-filter.md (100%) rename README.MAILINGLIST_RULES => docs/mailinglist-rules.md (100%) rename README.NEW-OUTPUT-API => docs/output-api.md (100%) rename README.PARAMETER_PARSING_API => docs/parameter-parsing-api.md (100%) rename README.RELEASE_PROCESS => docs/release-process.md (100%) rename README.SELF-CONTAINED-EXTENSIONS => docs/self-contained-extensions.md (100%) rename README.STREAMS => docs/streams.md (100%) rename README.UNIX-BUILD-SYSTEM => docs/unix-build-system.md (100%) diff --git a/README.md b/README.md index 45706d2425622..09dde4fdb8634 100644 --- 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 diff --git a/README.input_filter b/docs/input-filter.md similarity index 100% rename from README.input_filter rename to docs/input-filter.md diff --git a/README.MAILINGLIST_RULES b/docs/mailinglist-rules.md similarity index 100% rename from README.MAILINGLIST_RULES rename to docs/mailinglist-rules.md diff --git a/README.NEW-OUTPUT-API b/docs/output-api.md similarity index 100% rename from README.NEW-OUTPUT-API rename to docs/output-api.md diff --git a/README.PARAMETER_PARSING_API b/docs/parameter-parsing-api.md similarity index 100% rename from README.PARAMETER_PARSING_API rename to docs/parameter-parsing-api.md diff --git a/README.RELEASE_PROCESS b/docs/release-process.md similarity index 100% rename from README.RELEASE_PROCESS rename to docs/release-process.md diff --git a/README.SELF-CONTAINED-EXTENSIONS b/docs/self-contained-extensions.md similarity index 100% rename from README.SELF-CONTAINED-EXTENSIONS rename to docs/self-contained-extensions.md diff --git a/README.STREAMS b/docs/streams.md similarity index 100% rename from README.STREAMS rename to docs/streams.md diff --git a/README.UNIX-BUILD-SYSTEM b/docs/unix-build-system.md similarity index 100% rename from README.UNIX-BUILD-SYSTEM rename to docs/unix-build-system.md