From 9e9aa4268569a8424a4d0e55f08153391bdda7a9 Mon Sep 17 00:00:00 2001 From: Owen Leonard Date: Fri, 15 Oct 2021 12:26:16 +0000 Subject: [PATCH] Bug 27823: List upcoming steps during installation process This patch adds text to each step of the installation process showing which steps have been completed, which step is current, and which steps come next. This helps the user know where they are in the process. To test, apply the patch and begin the process of installing Koha. In my testing environment I drop the Koha database and create it again. On each step of the installation process, confirm that the list of steps is correct, showing the right stage in the process. Signed-off-by: David Nind Signed-off-by: Martin Renvoize Signed-off-by: Jonathan Druart --- .../intranet-tmpl/prog/css/src/installer.scss | 27 ++++++ .../en/includes/installer-doc-head-close.inc | 1 + .../prog/en/modules/installer/step1.tt | 60 +++++++++++- .../prog/en/modules/installer/step2.tt | 12 +++ .../prog/en/modules/installer/step3.tt | 93 +++++++++++++++++++ .../en/modules/onboarding/onboardingstep1.tt | 15 +++ .../en/modules/onboarding/onboardingstep2.tt | 15 +++ .../en/modules/onboarding/onboardingstep3.tt | 15 +++ .../en/modules/onboarding/onboardingstep4.tt | 15 +++ .../en/modules/onboarding/onboardingstep5.tt | 23 +++++ 10 files changed, 275 insertions(+), 1 deletion(-) diff --git a/koha-tmpl/intranet-tmpl/prog/css/src/installer.scss b/koha-tmpl/intranet-tmpl/prog/css/src/installer.scss index 19301fcec1..c9c4892abf 100644 --- a/koha-tmpl/intranet-tmpl/prog/css/src/installer.scss +++ b/koha-tmpl/intranet-tmpl/prog/css/src/installer.scss @@ -297,3 +297,30 @@ span.breadcrumbs { .deselectall.optional { display: none; } + +#steps { + border: 1px solid #EEE; + border-radius: 5px; + padding: 1em; + margin: 1em 0; + + ol { + font-size: 1.2rem; + list-style-type: none; + margin: 0; + } +} + + +.open { + color: #888; +} + +.current { + color: #000; + font-weight: bold; +} + +.complete { + color: green; +} diff --git a/koha-tmpl/intranet-tmpl/prog/en/includes/installer-doc-head-close.inc b/koha-tmpl/intranet-tmpl/prog/en/includes/installer-doc-head-close.inc index 3c1a5f4659..556d241762 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/includes/installer-doc-head-close.inc +++ b/koha-tmpl/intranet-tmpl/prog/en/includes/installer-doc-head-close.inc @@ -4,5 +4,6 @@ [% Asset.css("lib/jquery/jquery-ui-1.11.4.min.css") | $raw %] [% Asset.css("lib/bootstrap/bootstrap.min.css") | $raw %] +[% Asset.css("lib/font-awesome/css/font-awesome.min.css") | $raw %] [% Asset.css("css/installer.css") | $raw %] diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/installer/step1.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/installer/step1.tt index 2c6d5c6a59..45c56cf38c 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/installer/step1.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/installer/step1.tt @@ -26,7 +26,17 @@ [% UNLESS ( language ) %]

Web installer › Choose your language

-

You are about to install Koha.

+ +
+
    +
  1. Choose your language
    2. +
  2. Check Perl dependencies
    3. +
  3. Database settings
    4. +
  4. Set up database
    5. +
  5. Install basic configuration settings
    6. +
  6. Onboarding
    7. +
+

Please pick your language from the following list. If your language is not listed, please inform your system administrator.

@@ -57,6 +67,18 @@ [% UNLESS ( checkmodule ) %] [% IF ( missing_modules ) %]

Web installer › Perl modules missing

+ +
+
    +
  1. Choose your language
    2. +
  2. Check Perl dependencies
    3. +
  3. Database settings
    4. +
  4. Set up database
    5. +
  5. Install basic configuration settings
    6. +
  6. Onboarding
    7. +
+
+

Some Perl modules are missing. Important: Required modules must be installed before you may continue.

    [% FOREACH missing_module IN missing_modules %] @@ -69,6 +91,18 @@ [% IF ( upgrade_modules ) %]

    Web installer › Perl modules due for upgrade

    + +
    +
      +
    1. Choose your language
      2. +
    2. Check Perl dependencies
      3. +
    3. Database settings
      4. +
    4. Set up database
      5. +
    5. Install basic configuration settings
      6. +
    6. Onboarding
      7. +
    +
    +

    Some Perl modules require upgrade. Important: Required modules must be installed at the correct version before you may continue.

      [% FOREACH upgrade_module IN upgrade_modules %] @@ -83,6 +117,18 @@ [% IF ( problems ) %]

      Web installer › Perl version too old

      + +
      +
        +
      1. Choose your language
        2. +
      2. Check Perl dependencies
        3. +
      3. Database settings
        4. +
      4. Set up database
        5. +
      5. Install basic configuration settings
        6. +
      6. Onboarding
        7. +
      +
      +

      I encountered some problems.

        [% IF ( perlversion ) %] @@ -98,6 +144,18 @@ [% ELSE # IF checkmodule %]

        Web installer › Check Perl dependencies

        + +
        +
          +
        1. Choose your language
          2. +
        2. Check Perl dependencies
          3. +
        3. Database settings
          4. +
        4. Set up database
          5. +
        5. Install basic configuration settings
          6. +
        6. Onboarding
          7. +
        +
        +

        All required Perl modules appear to be installed.

        All dependencies installed.

        diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/installer/step2.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/installer/step2.tt index 37ec80f1e8..f2525c238f 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/installer/step2.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/installer/step2.tt @@ -10,6 +10,18 @@

        Koha

        Web installer › Database settings

        + +
        +
          +
        1. Choose your language
          2. +
        2. Check Perl dependencies
          3. +
        3. Database settings
          4. +
        4. Set up database
          5. +
        5. Install basic configuration settings
          6. +
        6. Onboarding
          7. +
        +
        +

        Database settings:

        • Database type: [%- dbms | $HtmlTags tag=>'code' -%]
          • diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/installer/step3.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/installer/step3.tt index d120234903..b3b92fdace 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/installer/step3.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/installer/step3.tt @@ -43,6 +43,18 @@

          Koha

          [% IF ( finish ) %]

          Web installer › Installation complete

          + +
          +
            +
          1. Choose your language
            2. +
          2. Check Perl dependencies
            3. +
          3. Database settings
            4. +
          4. Set up database
            5. +
          5. Install basic configuration settings
            6. +
          6. Onboarding
            7. +
          +
          +

          Congratulations, installation complete

          Begin the onboarding process

          [% END %] @@ -50,6 +62,21 @@ [% IF ( choosemarc ) %]

          Select your MARC flavor

          +
          +
            +
          1. Choose your language
            2. +
          2. Check Perl dependencies
            3. +
          3. Database settings
            4. +
          4. Set up database
            5. +
          5. Install basic configuration settings
            6. +
              +
            1. Select your MARC flavor
              2. +
            2. Selecting default settings
              3. +
            +
          6. Onboarding
            7. +
          +
          +
          @@ -74,6 +101,20 @@ [% IF ( selectframeworks ) %]

          Web installer › Selecting default settings

          +
          +
            +
          1. Choose your language
            2. +
          2. Check Perl dependencies
            3. +
          3. Database settings
            4. +
          4. Set up database
            5. +
          5. Install basic configuration settings
            6. +
              +
            1. Select your MARC flavor
              2. +
            2. Selecting default settings
              3. +
            +
          6. Onboarding
            7. +
          +
          @@ -162,6 +203,22 @@ [% IF ( addframeworks ) %]

          Web installer › Default data loaded

          + +
          +
            +
          1. Choose your language
            2. +
          2. Check Perl dependencies
            3. +
          3. Database settings
            4. +
          4. Set up database
            5. +
          5. Install basic configuration settings
            6. +
              +
            1. Select your MARC flavor
              2. +
            2. Selecting default settings
              3. +
            +
          6. Onboarding
            7. +
          +
          + [% FOREACH lis IN list %] [% IF lis.level == 'mandatory' %]

          Mandatory data added

          @@ -213,6 +270,18 @@ [% ELSE %]

          Web installer › Success

          Database tables created

          + +
          +
            +
          1. Choose your language
            2. +
          2. Check Perl dependencies
            3. +
          3. Database settings
            4. +
          4. Set up database
            5. +
          5. Install basic configuration settings
            6. +
          6. Onboarding
            7. +
          +
          +

          @@ -222,6 +291,18 @@ [% IF ( proposeimport ) %]

          Web installer › Set up database

          + +
          +
            +
          1. Choose your language
            2. +
          2. Check Perl dependencies
            3. +
          3. Database settings
            4. +
          4. Set up database
            5. +
          5. Install basic configuration settings
            6. +
          6. Onboarding
            7. +
          +
          +

          Now we're ready to create the database tables and fill them with some default data.

          @@ -237,6 +318,18 @@

          Update your database

          [% ELSE %]

          Web installer › Install basic configuration settings

          + +
          +
            +
          1. Choose your language
            2. +
          2. Check Perl dependencies
            3. +
          3. Database settings
            4. +
          4. Set up database
            5. +
          5. Install basic configuration settings
            6. +
          6. Onboarding
            7. +
          +
          +

          We are ready to do some basic configuration.

          diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep1.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep1.tt index 0320c1543b..a1f94b1180 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep1.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep1.tt @@ -13,6 +13,21 @@ [% INCLUDE 'onboarding_messages.inc' %] +
          +
            +
          1. Installation
            2. +
          2. Onboarding +
              +
            1. Create a library
              2. +
            2. Create a patron category
              3. +
            3. Create Koha administrator patron
              4. +
            4. Create a new item type
              5. +
            5. Create a new circulation rule
              6. +
            +
            3. +
          +
          +
          diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep2.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep2.tt index f6242a3b4f..f00b263fdf 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep2.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep2.tt @@ -23,6 +23,21 @@ [% INCLUDE 'onboarding_messages.inc' %] +
          +
            +
          1. Installation
            2. +
          2. Onboarding +
              +
            1. Create a library
              2. +
            2. Create a patron category
              3. +
            3. Create Koha administrator patron
              4. +
            4. Create a new item type
              5. +
            5. Create a new circulation rule
              6. +
            +
            3. +
          +
          +

          The patron category you create will be used by the administrator account.

          diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep3.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep3.tt index a1114f908b..6ca7bcfc40 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep3.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep3.tt @@ -15,6 +15,21 @@ [% INCLUDE 'onboarding_messages.inc' %] +
          +
            +
          1. Installation
            2. +
          2. Onboarding +
              +
            1. Create a library
              2. +
            2. Create a patron category
              3. +
            3. Create Koha administrator patron
              4. +
            4. Create a new item type
              5. +
            5. Create a new circulation rule
              6. +
            +
            3. +
          +
          +

          Now we will create a patron with superlibrarian permissions. Log in with this to access Koha as a staff member with all permissions.

          diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep4.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep4.tt index 69f057734f..8b76ba4cc3 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep4.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep4.tt @@ -12,6 +12,21 @@ [% INCLUDE 'onboarding_messages.inc' %] +
          +
            +
          1. Installation
            2. +
          2. Onboarding +
              +
            1. Create a library
              2. +
            2. Create a patron category
              3. +
            3. Create Koha administrator patron
              4. +
            4. Create a new item type
              5. +
            5. Create a new circulation rule
              6. +
            +
            3. +
          +
          +

          Item types are used to group related items. Examples of item types might be books, CDs, or DVDs.

          diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep5.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep5.tt index bc2254e719..c5d0ab3331 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep5.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/onboarding/onboardingstep5.tt @@ -19,6 +19,14 @@

          Web installer › Complete

          [% INCLUDE 'onboarding_messages.inc' %] + +
          +
            +
          1. Installation
            2. +
          2. Onboarding
            3. +
          +
          +

          Congratulations you have finished and are ready to use Koha

          Start using Koha @@ -28,6 +36,21 @@ [% INCLUDE 'onboarding_messages.inc' %] +
          +
            +
          1. Installation
            2. +
          2. Onboarding +
              +
            1. Create a library
              2. +
            2. Create a patron category
              3. +
            3. Create Koha administrator patron
              4. +
            4. Create a new item type
              5. +
            5. Create a new circulation rule
              6. +
            +
            3. +
          +
          +
          -- 2.39.5