[MAGNOLIA-3387] Improvement of installation process Created: 15/Nov/10  Updated: 09/Oct/12  Resolved: 26/Nov/10

Status: Closed
Project: Magnolia
Component/s: admininterface
Affects Version/s: 4.3.8
Fix Version/s: 4.4

Type: Improvement Priority: Major
Reporter: Andreas Weder Assignee: Andreas Weder
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: PNG File 1 Download page.png     PNG File 3 Installation instructions.png     PNG File 3.1 download file.png     PNG File 3.2 extract file.png     Text File 3.3 README.txt     PNG File 4 Welcome.png     PNG File 4.1 installer.png     PNG File 4.1.1 start up.png     PNG File 4.1.2 Log in.png     PNG File 5 Install STK.png     PNG File 5.1 STK installation instructions.png     PNG File 5.2 extract file.png     Text File 5.3 README.txt     PNG File 5.4 drop to author web-inf.png     PNG File 5.5 installer.png     PNG File 5.6 start up.png     PNG File 5.7 login.png     PNG File 6 done.png    
Issue Links:
dependency
depends upon MAGNOLIA-3397 Further wording improvements on insta... Closed
depends upon BUILD-24 Improvements/cleanup of readme files Closed
depends upon MAGNOLIA-3388 Set environment variables in a SETENV... Closed
depends upon MGNLEE-187 Set environment variables in a SETENV... Closed
depends upon MAGNOLIA-3383 Improve wording of install/update scr... Closed
depends upon MAGNOLIA-3398 Show template quick start page in sep... Closed
Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Date of First Response:

 Description   

The installation process currently is well documented in the installation instructions, but is still somewhat bumpy. You may easily miss the instructions, if you rush the installation, and some of the links referred to are pointing to the wrong files.

The goal of this issue is to make a couple of relatively easy amendments to improve the installation process of a user intending to download and try Magnolia with the options we have currently.



 Comments   
Comment by Andreas Weder [ 15/Nov/10 ]

Please find attached a number of screenshots and templates showing the new installation process. The first number of each file name refers to the step within the entire process.

Comment by Andreas Weder [ 15/Nov/10 ]

Here's the list of changes that I discussed with Grégory andBoris and which are documented in the archive I've attached before.

Step 1: Download page

  • add and adjust all points as per the mockup. "Hand" icon should be some kind of easy warning
  • replace links to trial and download with buttons
  • add a link to the installation instructions

(Implemented using existing means)

Step 2: Installation instructions

  • replace existing TOC with installation overview
  • add licensing remarks
  • collect the sub steps of each of the four main steps under separate titles , which link again to the (green) TOC
  • add a short paragraph describing how to visit the public website and log in to AdminCentral on the public instance (analogous to "log in to the author instance")

Step 3.3: README of cms bundle

  • move installation link to separate installation section

Step 4: Welcome

  • visually separate "congratulations" from rest
  • add separate section targeted at first time installs only (links open on sep. page)
  • slightly re-shape existing content under "the standard set up" section below
  • except for the installer links (which open in a separate window), links can be opened in the same window or a different one, but opening in a separate window should be visually less noisy.

Step 4.1: Installer

  • remove additional step (not shown any more in screenshots)
  • improve wording: mention install or update if there's anything to install or update respectively
  • if possible, improve wording of versioning (only mention version in task descriptions below the title; add a link like "update module xy from version A to version B" for update tasks).
Comment by Andreas Weder [ 15/Nov/10 ]

Step 5: Install templating

  • change page instructing you how to add templates as per the mockup
  • text should show up inside dialog on an empty website tree with grayed out toolbar buttons
  • change the links accordingly:
  • links should still offer to be opened in separate window, but not be as noisy

Step 5.3: STK README

  • point to module page containing installation instructions for STK
  • ensure that the README actually mentions the existence of installation instructions
Comment by Andreas Weder [ 15/Nov/10 ]

Changed: wording from "(Magnolia built-in installer)" to "Web update" to avoid confusion with actual installer.

Comment by Andreas Weder [ 15/Nov/10 ]

Changed: replaced place holder link to installation instructions with actual URL

Comment by Andreas Weder [ 26/Nov/10 ]

Most changes implemented with current means. Remaining two items have been split into separate issues and linked with this issue.

Comment by Magnolia International [ 17/Dec/10 ]

(sorry to wildly edit the title of this issue - while "Meliorate" is a perfectly valid word, it's a bit exotic for us non-englishophiles - or it's a germanism ) - my point was.. i couldn't find the issue by searching for it )

Comment by Andreas Weder [ 09/Oct/12 ]

Setting a proper fix version.

Generated at Mon Feb 12 03:45:59 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.