Skip to content
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.

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

[Documentation] Add CMS integration cookbook #9155

Merged
merged 4 commits into from
Feb 12, 2018

Conversation

bitbager
Copy link
Contributor

@bitbager bitbager commented Feb 6, 2018

Q A
Branch? 1.0
Bug fix? no
New feature? no
BC breaks? no
Deprecations? no
License MIT

@Zales0123 Zales0123 added the Documentation Documentation related issues and PRs - requests, fixes, proposals. label Feb 6, 2018
-----------------------------------

Default Sylius standard app does not come with a content management system. Don’t worry - our community has taken care of it. As Sylius does have an awesome dev oriented plugin environment,
our friends from `BitBag <https://bitbag.shop>`_ decided to develop their flexible CMS module. You can find it on `their GitHub <https://github.com/BitBagCommerce/SyliusCmsPlugin>`_.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sylius standard application does not come with a content management system. Although as Sylius does have a convenient plugin development environment,
the `BitBag <https://bitbag.shop>`_ contributors have decided to develop a flexible CMS module. You can find it `here, on their GitHub <https://github.com/BitBagCommerce/SyliusCmsPlugin>`_.

And please break the lines a bit :)


.. tip::

Check their `GitHub <https://github.com/BitBagCommerce>`_ for more awesome plugins like payment gateways integrations, shipment management and many more. Don't forget to leave a star if you liked their work!
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the plugins are already listed on this page: http://docs.sylius.org/en/latest/plugins/index.html#the-official-list-of-plugins No need to mention it here. Cookbooks are focusing on solving certain problems, plugin advertisements are rather clutter here.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I feel a little bit overwhelmed with amount of BitBag links in this cookbook 🎉

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👌

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

Find out more about how to use the plugin on `GitHub <https://github.com/BitBagCommerce>`_.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link is wrong I suppose.

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>`.

Installation & usage
-----------------------------------
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

too long line of -


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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And btw can we add here a sample guide on the plugin usage? Adding one simple block or sth?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be better to leave the usage inside the README as many things change inside the plugin core.


.. tip::

The whole plugin has its own `demo page <https://github.com/BitBagCommerce>`_ with specific use cases. You can access the `admin panel <https://github.com/BitBagCommerce>`_
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't look like a demo page or admin panel

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

Find out more about how to install the plugin on `GitHub <https://github.com/BitBagCommerce>`_.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/BitBagCommerce/SyliusCmsPlugin

Content management in Sylius
----------------------------

Default Sylius standard app does not come with a content management system. Don’t worry - our community has taken care of it.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Default Sylius standard app

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't worry - Our community...

----------------------------

Default Sylius standard app does not come with a content management system. Don’t worry - our community has taken care of it.
As Sylius does have an awesome dev oriented plugin environment, our friends from `BitBag <https://bitbag.shop>`_ decided to develop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are you writing about yourself as "our friends"? :D We love you BitBag, but to remain politically correct I'd get rid of this expression in the docs. :P

@CoderMaggie CoderMaggie merged commit 8531b41 into Sylius:1.0 Feb 12, 2018
@CoderMaggie
Copy link
Member

Thank you Mikołaj! 💪

@bitbager
Copy link
Contributor Author

Thank you, Magda! 🎉

@bitbager
Copy link
Contributor Author

When can we expect it to be in the official documentation?

@pamil
Copy link
Contributor

pamil commented Feb 13, 2018

Btw. you probably want to add an entry to docs/cookbook/shop/map.rst.inc to make it visible in the cookbook list :)

@bitbager
Copy link
Contributor Author

The link is not visible in the 1.1 Docs. Shall I provide another PR for the 1.1 branch?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation related issues and PRs - requests, fixes, proposals.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants