kenaug74/Sylius
1
0
Fork 0
mirror of https://github.com/Sylius/Sylius.git synced 2026-07-14 09:02:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

[ci skip] Clean up documentation merged into main repo

Browse source
This commit is contained in:
Paweł Jędrzejewski 2016-03-25 09:31:54 +01:00
parent 887fed6223
commit ebb59ec645
4 changed files with 12 additions and 50 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
PULL_REQUEST_TEMPLATE.md
View file

@ -6,5 +6,4 @@
| Deprecations? | no|yes
| Related tickets | fixes #X, partially #Y, mentioned in #Z
| License | MIT
| Doc PR | Sylius/Sylius-Docs#X

5
docs/PULL_REQUEST_TEMPLATE.md
View file

@ -1,5 +0,0 @@
| Q | A
| ------------- | ---
| Doc fix? | yes|no
| New docs? | yes|no
| Fixed tickets | #X

16
docs/README.md
View file

@ -1,21 +1,19 @@
Sylius
======
Sylius Documentation
====================
Modern ecommerce solution for Symfony2.
This directory contains documentation for Sylius - Decoupled eCommerce Platform, available on [**docs.sylius.org**](http://docs.sylius.org).
**This is official documentation repository**, available on [**docs.sylius.org**](http://docs.sylius.org).
Hosted by [readthedocs.org](http://readthedocs.org).
It is hosted by the great [readthedocs.org](http://readthedocs.org).
Sylius on Twitter
-----------------
If you want to keep up with updates, [follow the official Sylius account on twitter](http://twitter.com/Sylius).
If you want to keep up with all the updates, [follow the official Sylius account on twitter](http://twitter.com/Sylius).
Issues
------
The documentation uses [GitHub issues](https://github.com/Sylius/Sylius-Docs/issues).
The documentation uses [GitHub issues](https://github.com/Sylius/Sylius/issues).
Build
-----
@ -38,4 +36,4 @@ Documentation index is `build/index.html`.
Authors
-------
See the list of [documentation contributors](http://github.com/Sylius/Sylius-Docs/contributors).
See the list of [our amazing contributors](http://github.com/Sylius/Sylius/contributors).

40
docs/contributing/documentation/overview.rst
View file

@ -12,18 +12,18 @@ Contributing
Before contributing, you need to become familiar with the :doc:`markup
language <format>` used by the documentation.
The Sylius documentation is hosted on GitHub:
The Sylius documentation is hosted on GitHub, in the main repository:
.. code-block:: text
https://github.com/Sylius/Sylius-Docs
https://github.com/Sylius/Sylius
If you want to submit a patch, `fork`_ the official repository on GitHub and
then clone your fork:
.. code-block:: bash
$ git clone git://github.com/YOURUSERNAME/Sylius-Docs.git
$ git clone git://github.com/YOURUSERNAME/Sylius.git
The ``master`` branch holds the documentation for the development branch of the code.
@ -31,7 +31,7 @@ Create a dedicated branch for your changes (for organization):
.. code-block:: bash
$ git checkout -b improving_foo_and_bar
$ git checkout -b docs/improving_foo_and_bar
You can now make your changes directly to this branch and commit them. When
you're done, push this branch to *your* GitHub fork and initiate a pull request.
@ -40,7 +40,7 @@ Creating a Pull Request
~~~~~~~~~~~~~~~~~~~~~~~
Following the example, the pull request will default to be between your
``improving_foo_and_bar`` branch and the ``Sylius-Docs`` ``master`` branch.
``improving_foo_and_bar`` branch and the ``Sylius`` ``master`` branch.
GitHub covers the topic of `pull requests`_ in detail.
@ -62,36 +62,6 @@ You can also prefix the title of your pull request in a few cases:
.. _doc-contributing-pr-format:
Pull Request Format
~~~~~~~~~~~~~~~~~~~
Unless you're fixing some minor typos, the pull request description **must**
include the following checklist to ensure that contributions may be reviewed
without needless feedback loops and that your contributions can be included
into the documentation as quickly as possible:
.. code-block:: text
| Q | A
| ------------- | ---
| Doc fix? | [yes|no]
| New docs? | [yes|no] (PR # on Sylius/Sylius if applicable)
| Fixed tickets | [comma separated list of tickets fixed by the PR]
An example submission could now look as follows:
.. code-block:: text
| Q | A
| ------------- | ---
| Doc fix? | yes
| New docs? | yes (Sylius/Sylius#1250)
| Fixed tickets | #1075
.. tip::
Online documentation is rebuilt on every code-push to github.
Documenting new Features or Behavior Changes
--------------------------------------------