Skip to content

[Documentation] Add more rules to the contribution guide + Fix CMS cookbook #9189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pamil merged 3 commits into from
Feb 15, 2018
Merged

[Documentation] Add more rules to the contribution guide + Fix CMS cookbook #9189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
899adce
Fix CMS cookbook
Feb 14, 2018
f32992f
[Docs] Polish the CMS cookbook
Feb 14, 2018
75a0ddf
[Docs] Contributing standards enhanced
Feb 14, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/contributing/documentation/standards.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,10 @@ Language Standards

The Vitamins are in my Fresh California Raisins

* Do not use `Serial (Oxford) Commas`_;
* Please use appropriate, informative, rather formal language;
* Do not place any kind of advertisements in the documentation;
* The documentation should be neutral, without judgements, opinions. Make sure you do not favor anyone,
our community is great as a whole, there is no need to point who is better than the rest of us;
* You should use a form of *you* instead of *we* (i.e. avoid the first person
point of view: use the second instead);
* When referencing a hypothetical person, such as "a user with a session cookie", gender-neutral
Expand Down
8 changes: 4 additions & 4 deletions docs/cookbook/shop/cms.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Content management in Sylius
----------------------------

Sylius standard app does not come with a content management system. Our community has taken care of it.
As Sylius does have an awesome dev oriented plugin environment, developers from `BitBag <https://bitbag.shop>`_ decided to develop
their flexible CMS module. You can find it on `their GitHub <https://github.com/BitBagCommerce/SyliusCmsPlugin>`_.
As Sylius does have a convenient dev oriented plugin environment, the developers from `BitBag <https://bitbag.shop>`_ decided to develop
their flexible CMS module. You can find it `here <https://github.com/BitBagCommerce/SyliusCmsPlugin>`_.

.. tip::

Expand All @@ -28,12 +28,12 @@ Inside the plugin, you will find:
* Sections which you can use to create a blog, customer information, etc.
* FAQ module

What is the most awesome thing about this plugin is that you can customize it for your specific needs like you do with each :doc:`Sylius model </customization/model>`.
A very handy feature of this plugin is that you can customize it for your specific needs like you do with each :doc:`Sylius model </customization/model>`.

Installation & usage
--------------------

Find out more about how to install the plugin on `GitHub <https://github.com/BitBagCommerce/SyliusCmsPlugin>`_.
Find out more about how to install the plugin on `GitHub <https://github.com/BitBagCommerce/SyliusCmsPlugin>`_ in the README file.

Learn more
----------
Expand Down
1 change: 1 addition & 0 deletions docs/cookbook/shop/map.rst.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@
* :doc:`/cookbook/shop/taxons-menu`
* :doc:`/cookbook/shop/embedding-products`
* :doc:`/cookbook/shop/disabling-localised-urls`
* :doc:`/cookbook/shop/cms`