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.
The example site will include:
To keep the example site easily understandable and close to the core, no template overrides, custom CSS, or custom JavaScript will be used.
An excellent candidate for the example site is a “Travel Guide to Iceland.”
This would let Joomla show off:
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.
The Notes field in the backend (available for menus, modules, categories, and other content types) will be used to:
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:
By combining contextual notes and interactive guided tours, users receive layered, accessible explanations—supporting multiple learning styles and reducing the barrier to entry.
joomla/example-site
).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.
Labels |
Added:
No Code Attached Yet
|
Cordial saludo.
Me gusta la idea, añadiría algunas ideas a tener presente, no se si vaya en este proyecto u otro:
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.
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.
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
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.
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
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:
The goal is to show that Joomla! allows you to create professional sites in different fields and for different purposes.
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. ;-)
Sorry if I misunderstood you and thanks
Great idea!
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!
Labels |
Added:
Feature
|
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.
The production department meeting notes state that there are "open questions". Where/what are they?
sorry for the delay. here are our considerations/questions:
Functional requirements
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?
some things are already written in your proposal, but they were still discussed (i.e. installation workflow)
- 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
- 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)
- 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
- 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
- We don’t want icelandic Joomla demo websites all over the place - how can we solve this?
See point 2
- Shall we have watermarks on images?
I would leave that decision to the contributor of the photographs
- 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
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!
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.
I like the idea. Not sure if we get this maintained. But if we not try we will never know.