silverstripe / silverstripe-userhelp-content

User-level docs for the Silverstripe Framework and CMS

Silverstripe User Help

The Silverstripe CMS User Help in Markdown format, as published on userhelp.silverstripe.org (source).

License

CC Attribution 4.0 International

Thanks

Thanks to Paul Clarke, Sacha Judd, Aaron Carlino, Scott Hutchinson, Jake Dale, Jared Lee, Rachel Margaret, Benn Crawford and Nicole Williams, James Cocker purplespider, Fred Condo, Anita Graham, Nigel Vining, Stephen Metcalfe, Marcus Dalgren, the users going by the names of Martijn, Mike, Sunnybex, Fil, Stefdv and Brian Boyko.

silverstripe-userhelp-content's Issues

Duplicate content block

Hi SilverStripe team - can you advise if there will be the ability to duplicate a content block in the future?
This feature is normally housed in the editing ... button in other systems and would save time and error if blocks could be duplicated

• so that only the image and content needs to be changed (but saves having to set the styling).

Equally, if a content block could be moved from one page to another would be great (as I don't see this feature included in the v4 documentation.

Thanks Anna

test issue

[3.2] Broken link on /creating_and_editing_content/working_with_images_and_documents/

On https://userhelp.silverstripe.org/en/3.2/creating_pages_and_content/creating_and_editing_content/working_with_images_and_documents/ just above the "Inserting uploaded images" heading the link to "Uploading and Linking to Documents." is broken.

Image are not loaded

Images on the Session Manager page are not loaded

Demo URL in SS3's "Logging in" section is broken

See https://userhelp.silverstripe.org/en/3/managing_your_website/logging_in/#logging-in

The text says demo.silverstripe.org but the URL is ss3.demo.silverstripe.org, which is broken.

Document dependent pages functionality

Some CMS users have been uncertain as to what the "Dependent pages" tab is on pages in the CMS, mentioning that they couldn't find anything after searching through userhelp/cwp documentation.

'Advance' the docs for advanced workflow

I find the documentation on setting up an advanced workflow could be a lot clearer.

In particular the following parts in Section 4 are confusing:

Next, select the "Notify Publishers" action and fill out the "Notification Email". You can use several placeholders to create your email template. Set the from email, address, and subject fields. See the "Formatting Help" drop down for help.

The sample workflow only has a 'Notify users' action. Not all of the variables for the email content and headers are resolved.

Repeat these steps for the other actions (assign and notify) but this time setting the user to the "Initiator".

This is somewhat cryptic and does not relate to the available fields.

Further, the accompanying screenshots are relevant to SS3, but confusing for users on SS4. I suggest to update them.

Update blogs and categories

https://userhelp.silverstripe.org/en/4/optional_features/blogs/tags-and-categories
Getting quite a lot of negative feedback about the blog module and how it's not clearly documented.

"Explain where date and author are entered. They are impossible to find!"
"Should display an indication of how to enable the feature"
"How can I get a post by tag?"

More info on meta tag defaults

The information on how to use the default meta tag fields on pages is pretty light: https://userhelp.silverstripe.org/en/4/creating_pages_and_content/creating_and_editing_content/editing_content/#describing-your-content-with-metadata

We could at least include information on what meta tags will be provided by default with the framework, some information on this is captured here: https://docs.silverstripe.org/en/4/developer_guides/templates/common_variables/#meta-tags

Images are clickable and link to 404: Not found pages

Example: https://userhelp.silverstripe.org/en/4/optional_features/forms/form-submissions/ (click on any image)

User help for previewing an archived site

Migrated from silverstripe/silverstripe-framework#1553

created by: @adrexia (adrexia)
created at: 2012-07-31
original ticket: http://open.silverstripe.org/ticket/7728

---

Document version site preview in userhelp.

Should describe, whether when a user browses the archived version of a page and begins to navigate around the website, whether the rest of the site shows as of that same timestamp or not. See http://open.silverstripe.org/ticket/7656

Missing images on Session manager page

Looks like there is something up with the session manager images on this page https://userhelp.silverstripe.org/en/4/managing_your_website/session_manager/ the links are broken so assume its about how the URL was generated (seems different from the other pages).

PR: #169

Notes - consistency across guides

It would be good refactor where blue notes are used on the site. <div class="note" markdown="1"> to have some consistency throughout the site.

Rename '02_Creating_pages_and_content' and links

'02_Creating_pages_and_content' should be renamed to either '02_Pages_and_content' or '02_Managing_pages'. This is an enhancement as we would have to change the links in 4 to cater for this change.

Add user help for image size preset in TinyMCE & File details

See silverstripe/silverstripe-asset-admin#961 for more details.
Note: Available in 4.5

Broken links throughout userhelp

I've noticed a lot of broken links even throughout 3.6 such as:

Production: https://userhelp.silverstripe.org/en/3.6/creating_pages_and_content/working_with_images_and_documents

Correct link: https://userhelp.silverstripe.org/en/3.6/creating_pages_and_content/creating_and_editing_content/working_with_images_and_documents/

Best to check when the new folder was added (possibly 3.2), fix and merge these up.

User Help missing for translatable

Migrated from silverstripe/silverstripe-framework#1558

created by: @smagnusson (smagnusson)
created at: 2012-08-06
original ticket: http://open.silverstripe.org/ticket/7744

---

Add a page to http://3.0.userhelp.silverstripe.org/for-website-content-editors/ detailing how to make websites have pages in multiple languages, in other words, document the translatable module from a content author's perspective.

Update silverstripe-versioned-admin guides

Userhelp guides for silverstripe-versioned-admin should be updated to reflect the current UI.

The guides should cover the following:

• An updated Rolling Back Pages section.
• TBC

New UI:

Reference: silverstripe/silverstripe-versioned-admin#60

Broken links created by .md extension

There are quite a few broken links on userhelp.silverstripe.org due to links including a .md extension.
e.g [Creating content blocks](edit_content.md#creating-blocks)
Broken link: https://userhelp.silverstripe.org/en/4/optional_features/content_blocks/edit_content.md#creating-blocks/

@unclecheese and I discussed that there are too many to update manually so this would require creating a script.

Update instructions and images for in-modal file editing

With CMS 4.6.0 the following will be out of date: https://userhelp.silverstripe.org/en/4/creating_pages_and_content/creating_and_editing_content/images_and_documents/#uploading-images-from-a-page

There's now a new flow to edit file details and the UI looks slightly different. See implementation: silverstripe/silverstripe-asset-admin#813

And a summary of the change: https://docs.silverstripe.org/en/4/changelogs/4.6.0/#in-modal-editing

framework/en/3.1 page should have more targeted content

This is a default page for a lot of links (as backed up by analytics) but has a high bounce rate as there is very little content. The content on this page should be more targeted to helping visitors find content on the site rather then just a short introduction.

@camfindlay might be best to get community help regarding what could be of use here?

Test issue

Nothing

Update user help to reflect the relocation of the help link

User help "Help" section will need to be updated to reflect the new CMS help menu that has just been implemented #615 in the CMS menu.
Dev docs can be found here: Customise the CMS help Menu

SS4 User help?

This is conspicuous by its absence - are there plans to update for 4? Is it something the community could help with?

Update content on redirector pages

Add content about Redirector pages best practices:

• Make sure redirector pages are not visible in search results if they direct to internal pages—if the original page already exists. For external pages you would likely want it to show (configureable in page settings).

Add Elemental as an Optional feature

Add a symbolic link for the module 'Content blocks' in the Optional features section in 4 once userhelp guide has been completed.

Refactor optional features - replacing images and files

Refactor the contents of /en/3/optional_features/replacing_images_and_files/ to 'Working with images and documents' or a new section due to IA change in SS4.

Update docs to reflect new changes in UI: silverstripe/silverstripe-asset-admin#848 & silverstripe/silverstripe-asset-admin#1011

Old:

Version differences message

It would be good if we outlined how user help approaches the differences in experiences from version to version at the beginning of User Help.

Just a rough example... “These guides have been written with the latest release in mind, older version may find differences to the experience outlined here. Please be aware that every installation has likely been customised so differences are likely to occur. If you find the guides do not align to what you with what you expect the core CMS experience to be, then please submit an issue so we can update it accordingly.”

This means we don't have have to reference versions for each different experience released, but rather just keep it aligned with the latest release. It also means we don't have to cater to explaining multiple experiences or go back and clean out old version numbers which are just clogging up the guides. This should keep the guides a bit cleaner and more future proof.

Add user help for tractorcow/silverstripe-fluent

Would be good if we could add some user help for https://github.com/tractorcow/silverstripe-fluent/ to replace Translatable which is now unsupported and removed from the SS4 branch of user help. We would have to add the symbolic link under the 'Optional features' section in this repo.

cc @tractorcow

Add better buttons overview

Since better buttons has been added to core we will need some user guides for this area.
Old SS3 docs located here https://github.com/unclecheese/silverstripe-gridfield-betterbuttons

Module userhelp issues (quicklinks)

Taxonomy:
silverstripe/silverstripe-taxonomy#52

Asset Admin:
silverstripe/silverstripe-asset-admin#976

Add images to site summariser userhelp

Images should be added to the user guides here: https://github.com/bringyourownideas/silverstripe-maintenance

Guides: https://userhelp.silverstripe.org/en/4/optional_features/modules_report/

Add 3.6 branch

Current minor version of the CMS is 3.6, this repo will need a branch added for it so userhelp.ss can pull it in.

Add Site Summariser as an optional feature

Add a symbolic link for the module 'Site Summariser' in the Optional features section of 3 & 4 once userhelp guide has been completed.

Reference: bringyourownideas/silverstripe-maintenance#62

Migrating Content

There should be a section in the CMS User Help guide that covers how to Migrate content. There is a tool that lets users import content using a Document - creating Pages and Sub Pages from Headers and Sub-headers. It exists as a CWP Module. Users should be Prompted to either 1. View this tool in their CWP CMS, or 2. Be Prompted to ask their developer to deploy the module.

I believe the module is the document converter...
https://github.com/silverstripe/silverstripe-documentconverter
It is findable under help section called "other optional modules" but this is not how the Typical CMS user will want to be able to discover this feature.