Adds support files, and moves them under the docs/ tree.

Renames `doc/` to `docs/`, and updates the documentation build rules accordingly (see zendframework/zf-mkdoc-theme#28 for a related change to allow building docs from this location). The `CONTRIBUTING.md` has been moved under this new location. `CONDUCT.md` was renamed to `docs/CODE_OF_CONDUCT.md`. New support files were also added: - `docs/ISSUE_TEMPLATE.md` - `docs/PULL_REQUEST_TEMPLATE.md` - `docs/SUPPORT.md`
weierophinney · Aug 3, 2017 · 0717838 · 0717838
1 parent ca89148
commit 0717838
Show file tree

Hide file tree

Showing 16 changed files with 58 additions and 5 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -1,4 +1,4 @@
-/doc export-ignore
+/docs/book export-ignore
 /test export-ignore
 /.gitattributes export-ignore
 /.gitignore export-ignore

diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,4 @@
-doc/html/
+docs/html/
 vendor/
 phpunit.xml
 zf-mkdoc-theme/

diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@ $ composer require zendframework/zend-problem-details
 
 ## Documentation
 
-Documentation is [in the doc tree](doc/book/), and can be compiled using [mkdocs](http://www.mkdocs.org):
+Documentation is [in the doc tree](docs/book/), and can be compiled using [mkdocs](http://www.mkdocs.org):
 
 ```bash
 $ mkdocs build

diff --git a/CODE_OF_CONDUCT.md → docs/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md → docs/CODE_OF_CONDUCT.md
diff --git a/CONTRIBUTING.md → docs/CONTRIBUTING.md b/CONTRIBUTING.md → docs/CONTRIBUTING.md
diff --git a/docs/ISSUE_TEMPLATE.md b/docs/ISSUE_TEMPLATE.md
@@ -0,0 +1,11 @@
+Provide a narrative description of what you are trying to accomplish.
+
+### Code to reproduce the issue
+
+```php
+```
+
+### Expected results
+
+### Actual results
+
diff --git a/docs/PULL_REQUEST_TEMPLATE.md b/docs/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,17 @@
+Provide a narrative description of what you are trying to accomplish:
+
+- Are you fixing a bug?
+  - Detail how the bug is invoked currently.
+  - Detail the original, incorrect behavior.
+  - Detail the new, expected behavior.
+
+- Are you creating a new feature?
+  - Why is the new feature needed? What purpose does it serve?
+  - How will users use the new feature?
+
+- Is this related to quality assurance?
+  - Detail why the changes are necessary.
+
+- Is this related to documentation?
+  - Is it a typographical and/or grammatical fix?
+  - Is it new documentation?
diff --git a/docs/SUPPORT.md b/docs/SUPPORT.md
@@ -0,0 +1,25 @@
+# Getting Support
+
+Zend Framework offers three support channels:
+
+- For real-time questions, use our
+  [Slack](https://zendframework-slack.herokuapp.com)
+- For detailed questions (e.g., those requiring examples) use our
+  [forums](https://discourse.zendframework.com/c/contributors)
+- To report issues, use this repository's
+  [issue tracker](https://github.com/zendframework/zend-problem-details/issues/new)
+
+**DO NOT** use the issue tracker to ask questions; use Slack or the forums for
+that. Questions posed to the issue tracker will be closed.
+
+When reporting an issue, please include the following details:
+
+- A narrative description of what you are trying to accomplish.
+- The minimum code necessary to reproduce the issue.
+- The expected results of exercising that code.
+- The actual results received.
+
+We may ask for additional details: what version of the library you are using,
+and what PHP version was used to reproduce the issue.
+
+You may also submit a failing test case as a pull request.
diff --git a/doc/book/exception.md → docs/book/exception.md b/doc/book/exception.md → docs/book/exception.md
diff --git a/doc/book/index.html → docs/book/index.html b/doc/book/index.html → docs/book/index.html
diff --git a/doc/book/index.md → docs/book/index.md b/doc/book/index.md → docs/book/index.md
diff --git a/doc/book/intro.md → docs/book/intro.md b/doc/book/intro.md → docs/book/intro.md
diff --git a/doc/book/middleware.md → docs/book/middleware.md b/doc/book/middleware.md → docs/book/middleware.md
diff --git a/doc/book/quick-start.md → docs/book/quick-start.md b/doc/book/quick-start.md → docs/book/quick-start.md
diff --git a/doc/book/response.md → docs/book/response.md b/doc/book/response.md → docs/book/response.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,5 +1,5 @@
-docs_dir: doc/book
-site_dir: doc/html
+docs_dir: docs/book
+site_dir: docs/html
 pages:
     - index.md
     - Introduction: intro.md