Coding the open seas
All SilverStripe developers started out in the same place. We were explorers — outsiders looking in on the unknown. With meager skills and only our curiosity and passion for discovery filling our sails, we navigated uncharted waters, leaning on whatever documentation we could find, and engaging helpful members of the community who had once upon a time been in our position. When things got especially challenging, we may have waded through thousands of lines of source code, desperately seeking an answer, but happy to find just a clue.
Some of us are further along in that journey than others, but unless your name is Sam Minnée, Sigurd Magnusson, or Tim Copeland, SilverStripe and its idiosyncratic patterns were not magically imbued in your soul. You had to work to reach the understanding you have today. Such is the nature of open-source software — as fluency spreads, velocity increases. The product marches forward, but looking backward and leaving a trail of breadcrumbs for the next wave of newcomers is rarely done and scantly incentivised.
Don't drop the n00bs.
We don't have any solid metrics on how many developers abandon ship on their journey through the SilverStripe seas due to a perceived deficit in support, and even if we did, the numbers would be squishy at best. We can, however, deduct a lot from the empirical evidence that surrounds us. With little variance, open-source products that enjoy high adoption rates and a large volume of contributors also enjoy rich, extensive, and accessible educational resources. The cause-and-effect of that correlation is up for debate, but it is clear that if we want to grow SilverStripe, improving the documentation and lowering the barriers to entry cannot be ignored.
So where does SilverStripe stand on the continuum of "exclusive club" to "vibrant, inviting community?" We're much further along than we were, but not nearly as far as we want to be. That's where I come in.
For years I wanted to develop a proper educational resource for SilverStripe. My blog, LeftAndMain, had plans to become a much more robust resource full of experience-driven learning materials for SilverStripe, but progress waned, and I often felt like it would be a second job just to keep it fresh and relevant. Fortunately, it wouldn't have to become my second job, because this past May, it became my primary job, when SilverStripe on-boarded me as a Community Educator.
In my new role, I oversee the growth, improvement, and dissemination of educational resources for SilverStripe. This could be as simple as updating the core documentation or as complex as developing a full-featured online university for SilverStripe. Everything is on the table at this point, and for better or worse, I tend to think really big. I really want people to learn SilverStripe with ease, and enjoy it every step of the way.
There are some tangible updates that have unfolded over the last few months. The documentation site has benefitted from the hard work of community member Will Rossiter and now proudly showcases a new look-and-feel and informational architecture on its beta site. We are actively soliciting the community for feedback, and hope to launch the new documentation site by the end of the year.
So what's next?
I'm a big fan of experiential learning, and I see it as an area where SilverStripe is lacking. While standalone documentation alone is sufficient for those already proficient in the framework, new members of the community are better served by documentation that is surrounded by context, and promotes the "why" over the "how." Documentation needs to be relatable, and if new learners can make a connection between example code and a real-life project, the education takes on a much more palpable and digestible form.
To that end, we plan to roll out a rich library of tutorials, or "lessons" that teach core SilverStripe principles in the context of a real project. An imaginary client will submit feature requests, and we'll work through the process of breaking down needs into actionable tasks. We'll then demonstrate how to best complete those tasks with SilverStripe. The application we build through the tutorials will be a fully functional analog of public-facing site, and available on a public code repository, with each lesson tagged as a commit, allowing learners to time travel through the progression of the lessons.
Eventually, I would love to see lessons taxonomised into "courses" and further reinforced with some kind of interactive demonstration of acquired skill, such as a quiz or code sandbox.
Most importantly, documentation and all of its furnishings and accessories need to be living, breathing organisms in our open-source ecosystem. To let them lie stagnant is to hinder the growth of the product. Their basic needs to be cared for and fed will be of paramount focus for me, and I hope for all those who contribute to core and thirdparty documentation, as well.
Making SilverStripe more inviting to new community members is a complex issue that requires input and effort from a variety of angles. There is no singular issue that will make all the difference. Breadth is much more important than depth. Whether it's core documentation, community member blogs, Stack Overflow questions, or live training sessions, stronger support systems will grow our community of contributors, and lead us to a more robust and viable product suited for a vast array of applications.
Post your comment
Comments
advanced search
grid field
grid field - extensions
grid field - complex situations (extra fields on the join etc)
Front end form building - including validation with js
avoiding class-itis / pagetype itis.
data models as pages
geolocation
spam protection
extending core & modules with decorators etc
writing modules
installing & configuring & extending common essential modules.
ecommerce.
Make the site deployable on a standard linux VPS hosting. no solr, no apc etc.
Don't just cover simple stuff the existing tutorials cover.
Posted by Will Barker, 25/11/2014 1:09pm (10 years ago)
I guess many developers, like myself, will have abandoned SilverStripe.
In my opinion there are several problems that must be solved:
- SilverStripe needs a powerful shortcodes visual system that is easily expandable, which is similar to Wordpress and Joomla: PageBuilder, ...
- SilverStripe should be well documented, with a complete web multilingual example, with advanced search, blog, forum and ecommerce, which will serve as the basis for any developer projects.
- SilverStripe must have at least an advanced forum module: kunena style, EasyDiscuss ... with many extensions.
- SilverStripe must have an advanced blog module that has a similar Wordpress, EasyBlog functionality , ..., with many extensions.
- SilverStripe must have an advanced ecommerce module, much like VirtueMart, HikaShop, WooCommerce, ..., with many extensions and payment systems.
- SilverStripe should have advanced social networking module as BuddyPress, EasySocial, Community Builder..., with many extensions.
- SilverStripe must have a magazine with articles, like Joomla.
- SilverStripe must have at least one company that makes advanced themes for all these modules.
SilverStripe modules to these questions are antediluvian or nonexistent.
Only way that SilverStripe out of anonymity and may be adopted by a lot of developers.
Best regards,
Jose A.
Posted by Jose A.Molina, 05/11/2014 11:41pm (10 years ago)
Posted by Andrew, 05/11/2014 9:56pm (10 years ago)
if possible, I request to include a tutorial on how to use leftandmain , to create customised admin without used the modelAdmin
Posted by Thomas Paulson, 04/11/2014 7:14pm (10 years ago)
No one has commented on this page yet.
RSS feed for comments on this page | RSS feed for all comments