Resources
The various types of Orchard learning resources available here want to help you further enhance your Orchard skills.
Latest tutorial
-
Our full Orchard Core tutorial series, the Dojo Course 3 is here!
Tutorial, Dojo Course, Orchard CoreAfter a long wait, the new Orchard Core version of our legendary Dojo Course tutorial series is here, the Dojo Course 3!
Latest resource by the community
-
Chirping birds on the web: a little insight to understand the data management in Orchard
Community resource, Database, Content managementSébastien just tweeted about his new blogpost to tell you how Orchard manages the content items' data in the database by demostrating simple use-cases and the corresponding queries. It's a great read even if you're new to Orchard or a seasoned veteran!
Recently updated in the Orchard Dojo Library
-
Inline documentation guidelines
- Don’t overdo documentation as it can do more harm than use when going out of date, which it tends to do.
- Always document complex pieces of logic by briefly explaining what the code does and why.
- Always document unusual solutions, hacks or workarounds, and explain why they are necessary.
- It's advised to document interfaces, best with usage samples. This is especially true for services: Always document services, as these are commonly used by other developers too.
- Never use comments for mental notes (like "TODO"). Such notes should go into more appropriate places like an issue tracker, some common documentation or something else.
- Documentation should be as close to what it documents as possible to avoid going out of date.
- It's good to document what the aim of a type (mostly class or interface) is. This is to be able to quickly understand what a type does without having to understand its code.
- Write documentation just like you write code: Use correct grammar and punctuation (remember that comments are sentences), adhere to style conventions.
- Follow C# XML comment guidelines:
- C# keywords like
true
, referenced in XML comments, should be wrapped into asee
element as follows:/// <returns><see langword="true"/> on success, <see langword="false"/> otherwise.</returns>
- Generic types should be referenced as follows:
<see cref="ILookup{TKey, TValue}"/>
- As seen in the above examples, don't add a space before self-closing elements in XML comments. This is due to the way automatic tooling generates those elements, as it would be cumbersome to change every such instance.
- C# keywords like
- Use ASCII art to visualize something in 2D.
- There are some great tips in this blog post.
-
Visual Studio code snippets
You can use these code snippets to quickly generate code in some common scenarios during Orchard Core module and theme development. The snippets follow Orchard naming conventions. Check out this demo video for a quick overview of our snippets.
-
Team training (training topic)
Time requirement: 1h
-
Introduction
Time requirement: 1h 0m
-
Development environment advices
See this page.
-
Development environment advices
Some advices on how to set up your development environment for Orchard Core development.