Back in June last year, we asked for help in updating the SilverStripe documentation. We're happy to announce now that those updates have been made.
- First, we started a documentation team and a public mailing list that reviews existing material and keeps editorial oversight on new content. This raises the bar for our documentation quality, and we're still looking for community members to have a significant stake in this team.
- Second, we've moved the majority of the documentation to being stored as text files in the same version control repository as the SilverStripe CMS software itself. There needs to be separate sets of documentation for upcoming releases of SilverStripe distinct from the current version, and this approach ties the code and documentation together elegantly. This means we converted a great amount of text from the current DokuWiki format into our syntax of choice, Markdown. You can read the documentation by downloading it, or by visiting doc.silverstripe.com, which is automatically updated whenever the underlying documentation is changed in version control.
- Third, the doc.silverstripe.org website has been visually redesigned, and is entirely based of content sourced from code files as described above. The scope for content at this website remains the same, and covers installation, developer tutorials, and concepts like forms and themes. It links to detailed documentation for classes and objects at api.silverstripe.com.
- Fourth, alongside the move of documentation parts to version control, a clear separation of "official" documentation from user contributed content should help to keep information relevant and manageable. This doesn't change the fact that anybody can contribute to "official" docs, but hopefully we can establish a more proactive editorial process through a documentation team to ensure new content lands in the right place.
Overall, you shouldn't find that content has changed drastically, just that it's presented better, and isn’t as easily editable as when we were using a wiki. This new format means that we can keep all content up to date better.
We realise that removing wiki edit rights means that the barriers to contributing are a little higher, so we're imagining we’ll have fewer but more dedicated contributors. We really want to emphasise that we don't want to stop anyone from contributing. The site is open source, all the content is open source, and licensed under Creative Commons. It's as open as we can make it while still maintaining a manageable source that's current. For more information on how you can contribute, please read our contribution guide.
Here are some ideas on how you can help:
We're always interested to see what others are building with the SilverStripe CMS, so we've decided to start a series of profiles on what other companies and developers are doing. Today we talk to Aaron Carlino, who is otherwise known as Uncle Cheese, prolific forum-poster and all around legend.
Last Saturday, around a dozen devotees of SilverStripe CMS assembled themselves at the Southern Cross Bar in Wellington. They were lured by the prospect of free drinks, perhaps, but even more so, they came in order to contribute to to the CMS.Read full post
I'm not sure that we've publicly explained the SilverStripe templating system thoroughly yet. It is significantly different from other templating systems out there.Read full post
We're always interested to see what others are building with the SilverStripe CMS, so we've decided to start doing a series of profiles on what other companies and developers are doing. First up is the digital agency Heyday. They're a company from our own neighbourhood, and we’re huge fans of their Down to the Wire project about the history of the internet in New Zealand. I spoke to their technical director Shane Garelja about what they were up to.Read full post
We're excited to report that SilverStripe CMS has become Microsoft certified today. This is notable because Microsoft has certified a very small number* of web apps, and we're the first ever open source certified web app.Read full post
We'd like to give members of the SilverStripe CMS community a chance to learn how to contribute back to the project. We've had meet-ups in the past, and will continue to hold them, as they’re very important to us, but right now, the time for talking is done. Let's get our hack on!Read full post