This is a follow-up to #2938800: Finalize wording for Toolbar warning message

Problem/Motivation

When you install the demo Umami profile you have a warning message in the toolbar saying that you should not use this profile for production sites and it might not be enough information.

Proposed resolution

We should create a page explaining better the purpose and limitations of this demo.

Remaining tasks

Create the default content in the path /experimental.

Comments

ckrina created an issue. See original summary.

ckrina’s picture

markconroy’s picture

Umami is a demonstration of some of the features of Drupal core.

Umami is intended as a sample site installation only, with the feature set changing/improving over time as new features are added to Drupal. With this in mind, we expect users to install Umami and enjoy the experience, but not to use it as the basis for their own website. Rather, we expect you to delete your installation of Umami and install the Minimal or Standard profiles when you are ready to begin developing your own site.

When you update to a newer version of Drupal you may see some changes.

These changes might include:

  • changes to the theme (which might break the version of the theme you have installed). For example, if we have hard-coded a layout in the theme, but decide to use the suite of layout modules instead at a later date.
  • changes to site configuration. In this case, it will just mean that you do not have the latest configuration, but what you currently have should still work. If you want to be up-to-date with the latest features of Umami, you will need to empty your database and install a fresh installation of Umami.

Thanks for installing Umami. We hope you like it!

markconroy’s picture

Status: Active » Needs review
ikit-claw’s picture

Sounds good but I would add this may break your site because theme errors often return the white screen of death.

ikit-claw’s picture

Status: Needs review » Reviewed & tested by the community
eli-t’s picture

Status: Reviewed & tested by the community » Needs review

This issue is for creating the page. So we can't RTBC it until we have a patch that does that.

eli-t’s picture

Title: Create an internal page for Umami profile to explain whay it shouldn't be used in production sites » Create an internal page for Umami profile to explain why it shouldn't be used in production sites
Issue summary: View changes

(fix typos in title and description)

eli-t’s picture

Some minor tweaks/suggestions below. We also need a page title. I'd suggest "Umami Experimental Profile"

====================================

Umami is a demonstration of some of the features of Drupal core.

Umami is intended as a sample site installation only, with the feature set changing and improving over time as new features are added to Drupal. With this in mind, we expect users to install Umami and enjoy the experience, but not to use it as the basis for their own website going forward. Rather, we expect you to delete your installation of Umami and install the Minimal or Standard profiles when you are ready to begin developing your own site.

When you update to a newer version of Drupal you may see some changes.

These changes might include:

  • changes to the theme, which might break the version of the theme you have installed. For example, if we have hard-coded a layout in the theme, but decide to use the suite of layout modules instead at a later date.
  • changes to site configuration. In this case, it will just mean that you do not have the latest configuration, but what you currently have should still work. If you want to be up-to-date with the latest features of Umami, you will need to empty your database and install a fresh version of Umami.

Thank you for installing Umami. We hope you like it!

====================================

I'm still not sure about the phrasing in the two bullet points to be honest. We have to bear in mind the target audience of Umami, who may well not know what "breaking the theme" or "suite of layout modules" means.

eli-t’s picture

Version: 8.5.x-dev » 8.6.x-dev
StatusFileSize
new2.38 KB

Patch added to create /experimental page based on text in #9. Whilst the exact text hasn't been agreed, having the patch lets people spin it up on simplytest.me for easy reviewing.

also moving to 8.6.x.

Status: Needs review » Needs work

The last submitted patch, 10: 2941582_10_add_experimental_page.patch, failed testing. View results

steveparks’s picture

Hi,

My feedback is that it's a bit too much of a block of text, and people excited to get started might just skip past it, so my edits (building on Eli's suggestions) are to separate out the key messages a little. I also edit the phrasing to be a bit more direct and action-focused. Note that I use some basic markdown here.

====
# This installation is for demo purposes only

Umami is an example magazine website to demonstrate some of the features of Drupal core. It is intended as a demo only, and is not suitable to use as a foundation for building your own site

## Why Umami is just for demo use
The Umami feature set will change and improve over time as new features are added to Drupal. When you update to a newer version of Drupal you may see some changes in your Umami installation, such as:
- changes to the theme, which might break the version of the theme you have installed. For example, if we have hard-coded a layout in the theme, but later decide to use the suite of layout modules instead.
- changes to site configuration. In this case, it will just mean that you do not have the latest configuration, but what you currently have should still work. If you want to be up-to-date with the latest features of Umami, you will need to empty your database and install a fresh version of Umami.

## What to do when you want to use Drupal for real
Once you've tried Drupal out using Umami, and you want to build your own site, simply delete your installation of Umami and then install Drupal again, using the Minimal or Standard profiles.

Thank you for installing Umami. We hope you like it!
====

eli-t’s picture

Status: Needs work » Needs review

Text agreed by @markconroy and @Eli-T on slack / gdocs

Umami Experimental Profile

Umami is a demonstration of some of the features of Drupal core.

It is intended as a sample site installation only, with the feature set changing and improving over time as new features are added to Drupal. With this in mind, we expect you to install Umami and enjoy the experience, but not to use it as the basis for your own website. Rather, we expect you to delete your installation of Umami and install the Minimal or Standard profiles when you are ready to begin developing your own site.

If you update to a newer version of Umami there may be changes that break your existing installation.

These changes could include:

  • Changes to the theme (how the site looks). For example, if we have hard-coded a background image in the theme, but decide to use something else for this background image at a later date.
  • Changes to site configuration. In this case, you will not have the latest configuration, but your current installation should still work. If you want to be up-to-date with the latest features of Umami, you will need to empty your database and install a fresh version of Umami.

Thank you for installing Umami. We hope you like it!

eli-t’s picture

Ooo we have crossed the streams with @steveparks.

markconroy’s picture

StatusFileSize
new2.61 KB

Here's a patch with the text collaborated on in Google Docs tonight.

markconroy’s picture

StatusFileSize
new2.61 KB

Oops, I was missing a closing

tag.

markconroy’s picture

StatusFileSize
new2.62 KB

Ooops, looks like I was missing the

as well - it's hard to work with CSV files.

markconroy’s picture

StatusFileSize
new3.31 KB

Adding link to /experimental

markconroy’s picture

Committers, when (if) this is being committed, can you please credit steveparks as well please. He did a great review and suggestions for the content.

andrewmacpherson’s picture

Instead of importing a page node from a CSV, could this advice be provided by hook_help() - I assume profiles can do that?

The benefit is that hook_help() text goes through interface translation, so evaluators can get this advice in any language (even though Umami's specimen content isn't multilingual itself).

markconroy’s picture

We decided against hook_help() because users might turn off the help module.

Of course, users might delete their content either, but we had to make a decision on one and choose custom content. It also means we have another page in the website to demonstrate (without this page, there is only one internal page).

andrewmacpherson’s picture

Right-oh. It won't be foolproof whichever way it's done.

smaz’s picture

Title: Create an internal page for Umami profile to explain why it shouldn't be used in production sites » Create a drupal.org for Umami profile to explain why it shouldn't be used in production sites

I've discussed this with @markconroy a bit more:

hook_help is a possible problem if the help module is disabled.
A page within the demo could be deleted (or removed if the default content module is uninstalled). We also can't change the content on existing demos, if we have a better message / more instructions / fixes if demos break due to non-BC changes.

A page on drupal.org is probably best for this - we can update it & keep it relevant, plus people could find it if their content breaks.

I've made the page here, based on the content from the last patch:
https://www.drupal.org/docs/8/umami-drupal-8-demonstration-installation-...

markconroy’s picture

I'm happy with this solution.

We might need to situate the page on drupal.org within a new 'Drupal Profiles' section or something (along with the D8 Modules and Themes page(s)), but I think that's a side point, as the node ID on Drupal.org will not change.

I can't RTBC since I worked on it, so leaving it as Needs review until someone else comes along.

smaz’s picture

StatusFileSize
new722 bytes

Patch attached - no interdiff as this is a different approach.

markconroy’s picture

Title: Create a drupal.org for Umami profile to explain why it shouldn't be used in production sites » Create a drupal.org documentation page for Umami profile to explain why it shouldn't be used in production sites
kjay’s picture

Status: Needs review » Reviewed & tested by the community

I tested this on local. Installs fine, link works fine. Moving to RTBC :)

larowlan’s picture

Crediting @steveparks

  • larowlan committed 61a032b on 8.6.x
    Issue #2941582 by markconroy, Eli-T, smaz, ckrina, steveparks: Create a...
larowlan’s picture

Status: Reviewed & tested by the community » Fixed

Committed as 61a032b and pushed to 8.6.x.

One more down, please ping the Drupal 8 handbook documentation maintainers to have the docs page approved

David_Rothstein’s picture

I still think hook_help() would be preferable here - for several reasons mentioned in other issues, plus andrewmacpherson's comment above mentions another good one (translation).

To address concerns about what happens when the Help module is disabled, the toolbar could simply fall back to linking directly to the drupal.org documentation in that specific case.

I have created an issue to address this, and also to suggest some edits/etc for the drupal.org page so that it works a bit better as a standard "module" help page.

David_Rothstein’s picture

Status: Reviewed & tested by the community » Fixed

Not sure how the status got changed there - sorry.

  • alexpott committed b26073c on 8.5.x authored by larowlan
    Issue #2941582 by markconroy, Eli-T, smaz, ckrina, steveparks: Create a...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.