1. Executive Summary
This proposal recommends the inclusion of a full installable example website within Joomla 6. The example site will be a fully functional, content-rich package that can be optionally installed during setup. It will serve as a comprehensive learning tool for new users and a reference implementation for developers. Key features and configuration elements will be annotated using the existing "Notes" field in the backend, making the platform more self-documenting and easier to understand.
If you want to inspire people, they need to see its glory and majesty — not Lorem Ipsum or generic tutorial text.
People without creative imagination could finally understand the benefits of a CMS over a flat website builder.
2. Objectives
- Demonstrate Joomla 6’s full capabilities out of the box using meaningful, realistic content.
- Reduce the learning curve for new users and site builders.
- Provide a practical reference for layout, content types, and extensions.
- Encourage best practices in configuration and content structuring.
- Show the value of a CMS through rich content and dynamic presentation, not just filler or instructional text.
3. Implementation Details
3.1 Example Site Composition
The example site will include:
- Content Elements: Articles, categories, tags, schema markup, and custom fields.
- Menus & Modules:Main menu, footer menu, sidebar modules.
- Components: Pre-configured core components like Contacts, Banners, Smart Search, and Custom Fields.
To keep the example site easily understandable and close to the core, no template overrides, custom CSS, or custom JavaScript will be used.
- User Access Levels: Optional Multiple user roles (Administrator, Manager, Registered, etc.) for role-based demonstration.
- Multilingual Support: Optional multilingual configuration.
Example Scenario: A Travel Guide to Iceland
An excellent candidate for the example site is a “Travel Guide to Iceland.”
This would let Joomla show off:
- Multiple display options (lists, blogs, featured, category modules).
- Vibrant content layouts using custom fields.
- Schema.org integration for enhanced SEO.
- Stunning imagery to demonstrate media handling.
This approach creates a real-world scenario users can relate to and learn from.
An award-winning photographer, Yaniv Rozenman-Segal, who is also a Joomla site builder, will contribute some of his stunning photographs to ensure the example site is as close to a real, visually impactful website as possible.
3.2 Notes Field Usage and Guided Tours
The Notes field in the backend (available for menus, modules, categories, and other content types) will be used to:
- Explain the purpose of each item.
- Describe its relationship to other content or functionality.
- Highlight best practices and common pitfalls.
- Provide links to relevant Joomla documentation.
This approach helps make the backend self-explanatory, even for non-technical users.
Additionally, Joomla’s Guided Tours feature can be extended and integrated to walk users through how the example site is structured and built. For example:
- A tour could highlight how custom fields are used in the article view.
- A tour might guide the user through the site’s menu structure or module assignments.
By combining contextual notes and interactive guided tours, users receive layered, accessible explanations—supporting multiple learning styles and reducing the barrier to entry.
4. Installation Workflow
- The example site will be packaged as a sample data plugin, easily maintainable and extensible.
- An additional button will be available post-installation to remove all sample content. This button will include a clear warning that using it will reset the site to a clean install, and that any changes made to the sample site will be lost.
5. Benefits
- Inspiration & Impact: High-quality, meaningful content (e.g., a travel guide) helps users see the potential of Joomla, not just read about it.
- Onboarding Efficiency: New users quickly grasp site-building concepts.
- Educational Tool: Useful for training sessions, workshops, and documentation support.
- Developer Reference: Demonstrates optimal use of Joomla’s features and architecture.
- Community Engagement: Enables contributors to collaboratively improve and evolve the demo.
- Clear Value over Site Builders: By illustrating dynamic features like tags, schemas, and custom fields, Joomla’s superiority over static site builders becomes evident — even to users lacking a technical or creative background.
6. Maintenance & Governance (optional)
- The example site will be maintained in a dedicated GitHub repository (e.g.,
joomla/example-site
).
- Community members can submit updates, improvements, and language translations.
- Updates to the example site will be versioned in sync with major Joomla releases.
7. Conclusion
Adding a full installable example website to Joomla 6 enhances user experience, learning, and adoption. Leveraging the Notes field for contextual guidance turns Joomla into a partially self-documenting system. By using realistic, inspiring content like a travel guide to Iceland — and keeping the implementation close to core with no overrides or custom code — we can offer clarity, value, and beauty that educates and inspires.
This initiative supports both newcomers and experienced developers, aligning with Joomla's mission of empowering all users to build powerful web experiences.
Approval Requested:
Approval from the Joomla production team to proceed with planning, prototyping, and integrating the example site into the Joomla 6 release process.
I like the idea. Not sure if we get this maintained. But if we not try we will never know.