Inspiration
The inspiration for OCBC came from observing the significant learning curve associated with Orchard Core, especially for .NET developers new to CMS or modular frameworks. While the official documentation is comprehensive, it can be overwhelming for beginners. I noticed a lack of practical, beginner-friendly tutorials that walk developers through the essential concepts in a progressive, easily understandable way.
What it does
Orchard Core Basics Companion (OCBC) is a comprehensive guide designed to help .NET developers learn and master Orchard Core. It provides a clear, approachable, and practical path to understanding and building with Orchard Core, starting from the basics and progressing to more advanced topics. It uses real-world examples, step-by-step instructions, and a focus on best practices to ensure that developers can confidently build websites and applications. OCBC also includes dedicated guidance for deploying Orchard Core to AWS, covering essential services like ECS, S3, and Aurora.
How I built it
The content is structured in a progressive manner, with each chapter building upon the previous one. I'm focusing on providing clear explanations, runnable code examples, screenshots, and exercises to reinforce learning. The AWS deployment sections are based on my own experience deploying Orchard Core applications to AWS and are regularly tested to ensure accuracy.
Challenges I ran into
One of the biggest challenges has been balancing the need for comprehensive coverage with the desire to keep the guide beginner-friendly. It's tempting to delve into advanced topics, but I'm consciously trying to prioritize the core concepts and avoid overwhelming new users. Also, keeping up with the rapidly evolving Orchard Core ecosystem and ensuring the guide is up-to-date requires continuous effort. Specifically for the AWS section, the constantly updating AWS services and best practices also represent a challenge in keeping the documentation relevant.
What I learned
In creating OCBC, I've deepened my own understanding of Orchard Core and its intricacies. I've also learned a great deal about technical writing, documentation best practices, and the importance of providing clear and concise explanations. I've also gained valuable experience in structuring complex information in a way that is easy to navigate and understand. I also re-learned some basic concepts on AWS.
What's next for Orchard Core Basics Companion (OCBC)
My immediate focus is on completing the remaining chapters, including advanced module development, custom themes, workflows, and security best practices. I plan to incorporate feedback from the Orchard Core community to improve the guide accuracy and relevance. I also plan to expand the AWS deployment section.
Log in or sign up for Devpost to join the conversation.