Merge pull request #63 from clue/documentation

Improve documentation structure

Author: SimonFrings

docs/async/fibers.md

@@ -49,7 +49,7 @@ return value.
 >
 > This is a feature preview, i.e. it might not have made it into the current beta.
 > Give feedback to help us prioritize.
-> We also welcome [contributors](../more/community.md) to help out!
+> We also welcome [contributors](../getting-started/community.md) to help out!
 
 At the moment, fibers are available as a development version by installing
 [react/async](https://github.com/reactphp/async) from a development branch

docs/best-practices/deployment.md

@@ -348,4 +348,4 @@ Hello wörld!
 >
 > You're seeing an early draft of the documentation that is still in the works.
 > Give feedback to help us prioritize.
-> We also welcome [contributors](../more/community.md) to help out!
+> We also welcome [contributors](../getting-started/community.md) to help out!

docs/getting-started/community.md

@@ -0,0 +1,45 @@
+# Community
+
+Framework X is so much more than *yet another framework*, it is the way to
+introduce asynchronous programming to the broader PHP community. We believe it's
+essential to involve the whole community in all our processes and provide you
+with the opportunity to bring up your awesome ideas. 
+
+## Support
+
+We are where the open-source community is! We use
+
+* [GitHub discussions](https://github.com/clue/framework-x/discussions) and
+* [GitHub issues](https://github.com/clue/framework-x/issues)
+
+as a great way to keep track of discussions and follow the project progress and
+upcoming enhancements.
+See also our [community section](https://framework-x.org/#community) for more
+support options, including commercial ones.
+
+You may also reach out to us by mentioning [**@x_framework** on Twitter](https://twitter.com/x_framework).
+We would love to hear your feedback! ❤️
+
+## Want to help out?
+
+We actively invite contributors to this project!
+
+* Follow [**@x_framework** on Twitter](https://twitter.com/x_framework)
+* Engage in our [GitHub discussions](https://github.com/clue/framework-x/discussions)
+* Help by giving feedback or triaging [GitHub issues](https://github.com/clue/framework-x/issues)
+* Consider becoming a [sponsor on GitHub](https://github.com/sponsors/clue)
+* Contribute to our [GitHub repository](https://github.com/clue/framework-x) with a code or documentation PR. Happy hacking!
+
+If you've tried out X, no matter how small your experiment, make sure to share
+your results with the world! We would love to hear what you think about X in a
+tweet mentioning [**@x_framework**](https://twitter.com/x_framework). ❤️
+
+## Open source
+
+Framework X will be released as open-source under the permissive MIT license.
+This means it will be free as in free speech and as in free beer.
+
+We believe in open source and made a conscious decision to take this path.
+Being open-source means we can foster a community to focus on building the best possible framework together.
+Framework X builds on top of existing open-source projects and we want to give back to this community of awesome engineers and developers.
+Being open to outside contributions means we can guarantee interoperability with a vivid ecosystem and ensure the longevity of the project.

docs/getting-started/philosophy.md

@@ -0,0 +1,76 @@
+# Our philosophy
+
+## What drives us
+
+Framework X is so much more than *yet another framework*. Here's what drives
+us and how we make decisions for the framework.
+
+* **make easy things easy & hard things possible**
+
+    Making easy things easy is one of our leading mottos. If making the hard thing
+    possible involves making the easy thing hard, we would rather focus on the easy
+    thing.
+
+* **From quick prototyping RAD to production environments in hours**
+
+    Get started in minutes with a <abbrev title="Rapid Application Development">RAD</abbrev> prototype!
+    With X, you can get from prototypes to production in hours, not weeks.
+
+* **Batteries included, but swappable**
+
+    X provides everything you need to get started. We use a very composable
+    architecture, so all the parts are swappable in case you need custom
+    integrations.
+
+* **Reuse where applicable, but accept some duplication**
+
+    Code reuse is great! But if applying <abbrev title="Don't repeat yourself">DRY</abbrev>
+    involves too many abstractions, we would rather accept some duplication. We value simplicity
+    as a core design principle.
+
+* **Long-term support (LTS) and careful upgrade paths**
+
+    We're committed to providing long-term support (LTS) options and providing a smooth upgrade
+    path between versions. We want to be the rock-solid foundation that you can build on top of.
+
+* **Promote best practices, but don't enforce certain style**
+
+    We like <abbrev title="Domain-Driven Design">DDD</abbrev>, <abbrev title="Test-Driven Development">TDD</abbrev>,
+    and more. If you don't, that's fine, we like choice. While we encourage following best
+    practices and try to give recommendations, we don't enforce a certain style.
+
+* **Runs anywhere**
+
+    We support the latest versions but we only require PHP 7.1+ for maximum compatibility to
+    ensure X runs anywhere. From shared hosting to cloud-native!
+
+* **Open and inclusive community**
+
+    Framework X is so much more than the sum of its parts. In particular, see our awesome [community](community.md).
+
+## Architecture
+
+* **HTTP request response semantics**
+
+    Framework X is all about handling [HTTP requests](../api/request.md) and sending back
+    [ HTTP responses](../api/response.md).
+
+* **PHP runs everywhere**
+
+    We know, PHP has its quirks. But it also provides a unique opportunity with its huge ecosystem
+    that allows you to run X literally anywhere.
+
+* **shared-nothing execution (optional)**
+
+    We support PHP's default shared-nothing execution model when running with
+    [traditional stacks](../best-practices/deployment.md#traditional-stacks).
+
+* **built-in web server (optional)**
+
+    If you're ready, get even more awesome features with its
+    [built-in web server](../best-practices/deployment.md#built-in-web-server).
+
+* **Async PHP**
+
+    We're standing on the shoulders of giants. Thank you [ReactPHP](https://reactphp.org/) for
+    providing an awesome foundation!

docs/integrations/authentication.md

@@ -4,7 +4,7 @@
 >
 > You're seeing an early draft of the documentation that is still in the works.
 > Give feedback to help us prioritize.
-> We also welcome [contributors](../more/community.md) to help out!
+> We also welcome [contributors](../getting-started/community.md) to help out!
 
 * HTTP Basic auth easy to implement
 * Implementation as HTTP [middleware](../api/middleware.md) recommended

docs/async/child-processes.md docs/integrations/child-processes.mddocs/async/child-processes.md renamed to docs/integrations/child-processes.md

@@ -4,10 +4,10 @@
 >
 > You're seeing an early draft of the documentation that is still in the works.
 > Give feedback to help us prioritize.
-> We also welcome [contributors](../more/community.md) to help out!
+> We also welcome [contributors](../getting-started/community.md) to help out!
 
 * Avoid blocking by moving blocking implementation to child process
 * Child process I/O for communication
 * Multithreading, but isolated processes
 * See [reactphp/child-process](https://reactphp.org/child-process/) for underlying APIs
-* See [clue/reactphp-pq](https://github.com/clue/reactphp-pq) for higher-level API to automatically wrap blocking functions in an async child process and turn blocking functions into non-blocking [promises](promises.md)
+* See [clue/reactphp-pq](https://github.com/clue/reactphp-pq) for higher-level API to automatically wrap blocking functions in an async child process and turn blocking functions into non-blocking [promises](../async/promises.md)

docs/integrations/database.md

@@ -169,15 +169,15 @@ database implementations.
 > described above. For legacy integrations, we provide limited support for
 > blocking database calls such as PDO, Doctrine, etc., but as a rule of thumb,
 > going for an async alternative is usually somewhat more efficient.
-> See [child processes](../async/child-processes.md) for more details.
+> See [child processes](child-processes.md) for more details.
 
 ## DBAL
 
 > ⚠️ **Feature preview**
 >
 > This is a feature preview, i.e. it might not have made it into the current beta.
 > Give feedback to help us prioritize.
-> We also welcome [contributors](../more/community.md) to help out!
+> We also welcome [contributors](../getting-started/community.md) to help out!
 
 There is ongoing effort to provide an async DBAL (DataBase Abstraction Layer)
 that will allow you to write your logic in such a way that it is not tied to a
@@ -794,7 +794,7 @@ structures to get you started:
 >
 > This is a feature preview, i.e. it might not have made it into the current beta.
 > Give feedback to help us prioritize.
-> We also welcome [contributors](../more/community.md) to help out!
+> We also welcome [contributors](../getting-started/community.md) to help out!
 
 If you're using X behind a [traditional web server](../best-practices/deployment.md#traditional-stacks),
 there's nothing to worry about: PHP will process a single request and then clean

docs/integrations/filesystem.md

@@ -4,11 +4,11 @@
 >
 > You're seeing an early draft of the documentation that is still in the works.
 > Give feedback to help us prioritize.
-> We also welcome [contributors](../more/community.md) to help out!
+> We also welcome [contributors](../getting-started/community.md) to help out!
 
 * Async APIs with [Promises](../async/promises.md)
 * Avoid using blocking `fopen()`, `file_get_contents()` and family
 * Few blocking calls *can* be acceptable
 * See [reactphp/filesystem](https://github.com/reactphp/filesystem) for filesystem prototype
-* Avoid blocking filesystem by using [child process](../async/child-processes.md)
+* Avoid blocking filesystem by using [child process](child-processes.md)
 * See [clue/reactphp-s3](https://github.com/clue/reactphp-s3) for async S3 filesystem API (supporting Amazon S3, Ceph, MiniIO, DigitalOcean Spaces and others)

docs/integrations/queueing.md

@@ -4,7 +4,7 @@
 >
 > You're seeing an early draft of the documentation that is still in the works.
 > Give feedback to help us prioritize.
-> We also welcome [contributors](../more/community.md) to help out!
+> We also welcome [contributors](../getting-started/community.md) to help out!
 
 * Common requirement to offload work from frontend to background workers
 * Major queue vendors supported already

docs/integrations/sessions.md

@@ -4,7 +4,7 @@
 >
 > You're seeing an early draft of the documentation that is still in the works.
 > Give feedback to help us prioritize.
-> We also welcome [contributors](../more/community.md) to help out!
+> We also welcome [contributors](../getting-started/community.md) to help out!
 
 * Session handling common requirement and not hard to implement
 * Implementation as HTTP [middleware](../api/middleware.md) recommended