-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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] Sylius 1.0 - The Documentation Plan #5275
Comments
Hell, it's about time! 😋 |
@okwinza Definitely! We are migrating some stores from various platforms, so we could share some ideas and insights but I am really hoping that community will share more too. :) |
@okwinza @pjedrzejewski should it be a subchapter of The Cookbook or an individual one? |
@TheMadeleine I think we could have a Migration Guide section with migration instructions from specific platforms and general tips for custom shops migrating to Sylius. For example: How to write a product import command, how to write a command that gets products from different database connection, etc. That being said, it is quite ambitious to think about having all this migration stuff anytime soon, but hopefully more people migrate and someone finds time to write these docs. :) |
@TheMadeleine IMO it should be dedicated chapter since it's a more broad topic than "how to reset a password" But some things can be extracted to the cookbook(like "How to create a User/[ResourceName] programmatically", etc) for sure. |
Ooups, missclick. 💃 |
In case it helps you, in the Symfony Docs we had a "Glossary" section since day one. The traffic it gets is residual and we're gonna remove it soon. I wouldn't waste any effort on that. By the way, I agree with others about the migrating to Sylius docs. I can imagine for example a "Migrating from Magento to Sylius" article that provides not only technical advice and commands/code samples but also a brief explanation of the main conceptual differences between both platforms. |
@javiereguiluz Thanks for the feedback Javier, it helps a lot! @TheMadeleine It was my idea to add a glossary, but I agree we could skip that part. :) |
@javiereguiluz good point! What is more, all from "Glossary" section will be described in "System Architecture" anyway. |
Another thing I miss from the documentation plan (which by the way is great) is the "systems administration" part: how to deploy a Sylius project, migrate/upgrade between versions (e.g. database migrations), important things to monitor in a production Sylius project, a security checklist of things to double-check to make Sylius safe, etc. |
a lot of the classes became final and all who ask about how to modify the behavior are pointed to decorating. but I'd be interested in an example of how Sylius (team) would use this pattern when trying to achieve a goal such as "we need to change the behavior of this factory". do you think this question deserves a page in the documentation? |
also, I'd use the link as a RTFM for all further questions how "why is this class final, omg, how am I going to extend this" 🗡️ but that's only me being "friendly" 💃 |
@gabiudrescu IMO it would be more useful to explain why these classes were made final and why you don't need to extend them in the first place. |
@okwinza AFAIR it was explained few times on Sylius issues. Anyway, the question We have to be aware that we have to maintain this code. Each public or protected method can cause a potential BC break. Final classes and private methods protect us from it and should be used wherever it is possible. With the interface we make a contract that the class which fulfill it will work correctly. We have also provided a sample implementation of them which resolves some problem. But not all of available cases. I hope it clarify a little bit. |
@okwinza that's also a good idea. |
One important thing - "How to customize factories?" article comes to my mind :) And I must agree with @lchrusciel . |
@TheMadeleine +1 or maybe even generic article: How to customize Sylius services? Which explains how we do it on few examples, including the factory. WDYT? |
It seems like the issue is... DONE! 🎉 🎉🎉 It took me some time to realise that all these ideas here are already covered! :D 💪 |
congrats @CoderMaggie for leading this effort. |
Hello Folks! 👋 👌 🙌
As we are currently approaching the final Sylius 1.0 BETA we have started thinking about upgrading our documentation. You've probably noticed a few emerging PRs to the Docs ( #5174, #5195, #5214 ) which are just a beginning of a whole big revolution.
We would love to develop understandable, well-organized, comprehensive documentation. To achieve that we will be needing strong assistance of the Sylius community. Every single PR with the [Documentation] tag will be appreciated a lot. :)
The Documentation Plan 📖
Together with @pjedrzejewski and @michalmarcinkowski we have sketched a detailed (but still initial) plan for the docs development.
The docs are divided into chapters and subchapters. Those which are for now the most important ones are marked with a 💥 .
We are presenting them as a checklist so that everyone will be able to see what has been already done, with a link to relevant PRs.
THE BOOK:
The Installation: 💥
System Architecture:
Detailed concepts of Sylius:
Channels ( [Documentation] Concepts: Channels #5511 )
Currencies ( [Documentation] Concepts: Currencies #5527 )
Locales ( [Documentation] Concepts: Locales #5518 )
Addressing
Shipping
Payment
Summary
Countries
Zones
Categories
Rates
Zones
Methods
State Machine
Methods
Categories
Zones
State Machine
Promotions
Coupons
Groups
THE CUSTOMIZATION GUIDE 💥 💥 💥 -> #5214
THE COOKBOOK
THE MIGRATION GUIDE
SYLIUS BUNDLES DOCUMENTATION
SYLIUS COMPONENTS DOCUMENATION
Final Thoughts 🏁
💚 Thanks guys for getting through this long issue. 💚
As the whole process has already started we are encouraging you to take part in it. Even just reviewing the docs will be a great help.
We are looking forward for your feedback!
The Sylius Team
The text was updated successfully, but these errors were encountered: