Feature No Code Attached Yet
avatar brianteeman
brianteeman
23 Jun 2025

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.

avatar brianteeman brianteeman - open - 23 Jun 2025
avatar joomla-cms-bot joomla-cms-bot - change - 23 Jun 2025
Labels Added: No Code Attached Yet
avatar joomla-cms-bot joomla-cms-bot - labeled - 23 Jun 2025
avatar brianteeman brianteeman - change - 23 Jun 2025
The description was changed
avatar brianteeman brianteeman - edited - 23 Jun 2025
avatar rdeutz
rdeutz - comment - 23 Jun 2025

I like the idea. Not sure if we get this maintained. But if we not try we will never know.

avatar nfbauti
nfbauti - comment - 8 Jul 2025

Cordial saludo.

Me gusta la idea, añadiría algunas ideas a tener presente, no se si vaya en este proyecto u otro:

  • Un pequeño tutorial (si no existe y si existe, mejorarlo) relacionado con archivo robots.txt, tips, soluciones y mejoras para sitios nuevos y existentes.
  • Un pequeño tutorial (si no existe y si existe, mejorarlo) relacionado con archivo htaccess, tips, soluciones y mejoras para sitios nuevos y existentes.
  • Un pequeño tutorial (si no existe y si existe, mejorarlo) relacionado con SEO, tips, soluciones y mejoras para sitios nuevos y existentes.

La verdad, a Joomla le falta mejorar enormemente los aspectos anteriores especialmente cuando se inicia un sitio nuevo y estas recomendaciones deberian tenerse presente antes de crear el contenido y así, aplicar estas mejoras y despues de ello si centrarse en el diseño y contenido y no al revés.

avatar ceford
ceford - comment - 24 Jul 2025

I like this proposal! Whilst working on documentation I needed standard content in several languages and considered creating a plugin. I have reservations about the use of a Travel Guide to Iceland and reliance on copyrighted images. I just asked ChatGPT for a Geyser image and it did a pretty good job. Nature worked for me - plants and animals.

Image

avatar brianteeman
brianteeman - comment - 24 Jul 2025

reliance on copyrighted images.

The photographer is well aware of the copyright implications of the photos being included and has agreed.

To be honest though we are only 26 days until the feature freeze so its too late now to do this before then

avatar cyrez
cyrez - comment - 30 Aug 2025

Since I'm also a professional photographer, for the rights, you just need to write a usage agreement with the conditions and time limits for the transfer of rights. Nothing complicated, especially when the photographer offers it himself. In addition, in the example, adding the caption with the author's copyright will be required.

avatar brianteeman
brianteeman - comment - 30 Aug 2025

Since I'm also a professional photographer, for the rights, you just need to write a usage agreement with the conditions and time limits for the transfer of rights. Nothing complicated, especially when the photographer offers it himself. In addition, in the example, adding the caption with the author's copyright will be required.

The photographer is already aware and in agreement

avatar cyrez
cyrez - comment - 30 Aug 2025

Regarding the proposal, it's an excellent one! 💯
It's a shame it didn't get the attention it deserved earlier, but it's never too late to make it happen! Even if it's for version 6.1.

Furthermore, it would be an interesting first example.

We could consider having other examples of sites available later:

  • A Travel Guide to Iceland (The current proposal by @brianteeman)
  • A website for a company
  • A news website
  • A blog site
  • Etc.

The goal is to show that Joomla! allows you to create professional sites in different fields and for different purposes.

avatar cyrez
cyrez - comment - 30 Aug 2025

Since I'm also a professional photographer, for the rights, you just need to write a usage agreement with the conditions and time limits for the transfer of rights. Nothing complicated, especially when the photographer offers it himself. In addition, in the example, adding the caption with the author's copyright will be required.

The photographer is already aware and in agreement

Yes, i've read you post. It was just to confirm it to @ceford that is was not an issue there and to say in a way that i'm 100% for real photographies than AI pictures. ;-)

avatar brianteeman
brianteeman - comment - 30 Aug 2025

Sorry if I misunderstood you and thanks

avatar Elfangor93
Elfangor93 - comment - 30 Aug 2025

Great idea!

avatar webgras
webgras - comment - 1 Sep 2025

I read your proposal. I really like the idea. For the moment, I am still not convinced that a travel guide is the best solution, but it is definitely a topic to handle many aspects. I will take it to the production department meeting tomorrow.
Thank you a lot so far!

avatar alikon alikon - change - 1 Sep 2025
Labels Added: Feature
avatar alikon alikon - labeled - 1 Sep 2025
avatar brianteeman
brianteeman - comment - 1 Sep 2025

Thank you. The subject could be anything. I chose a travel guide as I could quickly envisage multiple categories of content that could be presented in different ways and using tags, custom fields and more with it. The Drupal equivalent (which I also helped with) was a food magazine. It was great for showcasing fields but was quite restrictive in content categories - it's really just recipes. Plus I admit I was inspired to use Iceland as it's not a well visited area and the photographs we have access to are truly stunning.

avatar brianteeman
brianteeman - comment - 9 Sep 2025

The production department meeting notes state that there are "open questions". Where/what are they?

avatar rdeutz
rdeutz - comment - 11 Sep 2025

The production department meeting notes state that there are "open questions". Where/what are they?

Sigrid made some notes and will get back to you, at least that's what we discussed. The last days were busy days as you know. /cc @webgras

avatar webgras
webgras - comment - 15 Sep 2025

sorry for the delay. here are our considerations/questions:
Functional requirements

  1. Allow installation only on fresh installs? Not on top of existing data?
  2. Would it be possible to also remove example data? or reset installation? (idea: use a second dataset/database)

Content / branding concerns
3. We don’t want icelandic Joomla demo websites all over the place - how can we solve this?
4. Shall we have watermarks on images?
5. Add “sample data” to meta description?

Structural decisions
6. Should/could/would this example website replace the current sample data plugin? Is it optin/optout on installation?
7. Remove current sample data plugin and implement a new concept to install them from an official source?

avatar webgras
webgras - comment - 15 Sep 2025

some things are already written in your proposal, but they were still discussed (i.e. installation workflow)

avatar brianteeman
brianteeman - comment - 17 Sep 2025
  1. Allow installation only on fresh installs? Not on top of existing data?

In drupal the sample site is installed as an installation profile during site install. The downside to that approach for Joomla (its what we used to do) is that the sample data is not available if you are using a hosts one click installer. As long as we add the reset functionality in point 2 we can ensure its only installable on a clean site. This is something we really need anyway for the current sample data plugins

  1. Would it be possible to also remove example data? or reset installation? (idea: use a second dataset/database)

Being able to "reset an installation" would be an essential requirement for me. Its functionality we dont currently have but is something that would be useful even without this proposal. (the drupal approach is to just do a fresh install after checking out the sample site but I dont see that as a suitable or user friendly option)

  1. Should/could/would this example website replace the current sample data plugin? Is it optin/optout on installation?

Thats a decision outside the scope of this proposal

  1. Remove current sample data plugin and implement a new concept to install them from an official source?

Installing a sample site from an official source is one approach I have considered. I like the idea of downloading and installing the sample site as it also removes the need to ship Joomla with the sample site and its images

  1. We don’t want icelandic Joomla demo websites all over the place - how can we solve this?

See point 2

  1. Shall we have watermarks on images?

I would leave that decision to the contributor of the photographs

  1. Add “sample data” to meta description?

Yes that should be part of the sample data AND there would also be a module on the front end stating its a dummy site with dummy data AND a module in the admin stating that the dummy site is installed. note: i have no idea how to update the global meta description with an install

Additional considerations
The current sample data plugins are manually crafted and would be very complex to write for a full site. They do have the advantage over sql in that the content can be translated so ideally tooling would be needed to extract the sample data from a test site and convert it to the current plugin architecture

I can build a site with all the iceland content etc but would need the assistance of people far cleverer than me to

  1. Convert the site to something installable -
  2. Create a new reset the site functionality
avatar ceford
ceford - comment - 17 Sep 2025

I like the idea of having something installable from a remote source. That way there could be several Example Websites for different consumers. And with a given architecture there may be several volunteers willing to show what they can do. Hey-ho!

avatar Llewellynvdm
Llewellynvdm - comment - 23 Sep 2025

I really like the general direction of this proposal and I can see how it would help new users understand Joomla more quickly and see its full potential. A complete, content-rich example site would definitely be inspiring and a good teaching tool.

My main caution is simply that we should be careful not to make this too "official-only" in a way that would lock out others. It would be a pity if this became a feature that only the core team could produce content for. Ideally, this should be something that the whole community could use — both to install the official example site, and to build their own packages for their own use cases. This would make it valuable not just as a demo, but also as a way for agencies, template providers, or SaaS-style setups to spin up fully preconfigured Joomla sites for their clients.

We should also be mindful of what already exists. Many template frameworks and vendors already ship their own pre-configured starter sites by bundling them with the installer. If we introduce a new approach, we should try to improve the current workflow rather than break or replace it. Preserving backward compatibility wherever possible helps prevent alienating those who've invested time building on top of Joomla's current behaviour.

In short: I'm very supportive of this proposal, as long as it remains open and extensible for the wider community and avoids closing the door on other approaches. If we do this well, it could be both a fantastic demo site and a foundation for a richer ecosystem of installable site packages.

Add a Comment

Login with GitHub to post a comment