This is implementing the bootstrap styling work that Owen Leonard did in bug 17942 onto the onboarding tool (bug 17855) and the web installer.
Created attachment 62424 [details] [review] Bug 17942 - Update style of the web installer with Bootstrap 3 This patch makes style and markup changes to the web installer and new onboarding tool (Bug 17855). - Markup has been corrected, improved, and in many places reindented. - Some page titles have been made more specific. - Some JavaScript and CSS have been moved to separate files. In the onboarding tool I have removed form validation from the markup and JavaScript in many cases where the requirements were not matched elsewhere in Koha. For instance, we shouldn't limit item type descriptions to only letters because the database doesn't require such a limit. To test, apply the patch and run the web installer with an empty database. Confirm that the installation process completes correctly and that each page looks good and works correctly. Signed-off-by: Josef Moravec <josef.moravec@gmail.com> Signed-off-by: Liz Rea <liz@catalyst.net.nz>
Created attachment 62425 [details] [review] Bug 18462 - Merged patches on bugs 17855 and 17942 to implemented the bootstrap styling onto the web installer and newly altered onboarding tool.
Created attachment 62426 [details] [review] Bug 17855: Onboarding tool Tested 3 patches together on current master - Dropped database - Recreated database - Went through installer - Language en, Marc21 - Installed mandatory data only - Went through Onboarding tool - After finishing, logged in as superlibrarian that was created by onboarding tool Everything worked fine. Signed-off-by: Marc Véron <veron@veron.ch> Signed-off-by: Marc Véron <veron@veron.ch> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
Created attachment 62427 [details] [review] Bug 17855 - Reverted back to original step 3 in the web installer so there is no basic and advanced setup mode and consequently no need for SQL files to be moved to a 'default' directory for all languages. Onboarding tool and the rest of the web installer still exists in this commit How I tested in my VM (Current master): - Dropped database - Recreated database - Went through installer - Language en, Marc21 - Installed mandatory data only - Went through Onboarding tool - After finishing, logged in as superlibrarian that was created by onboarding tool Everything worked fine. Signed-off-by: Marc Véron <veron@veron.ch> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> Bug 17855 - Followup patch following requests in comments 176 and 177 Signed-off-by: Marc Véron <veron@veron.ch> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> Bug 17855: perltidy onboarding.pl Signed-off-by: Alex Buckley <alexbuckley@catalyst.net.nz> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> Bug 17855: Do not create a new dbh, get it from C4::Context->dbh Signed-off-by: Alex Buckley <alexbuckley@catalyst.net.nz> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> Bug 17855: Redirect to the installer if installation process is not done yet Signed-off-by: Alex Buckley <alexbuckley@catalyst.net.nz> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> Bug 17855: No need to resend the library list to the template This has been done at the beginning of the script Signed-off-by: Alex Buckley <alexbuckley@catalyst.net.nz> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> Bug 17855: Simplify the onboarding tool This patch should not modify a lot the behaviours of the onboarding tool. Its goal is mainly to remove duplicated as well as useless (because copy/pasted from existing script files) code. It assumes that the onboarding tool will be done on an empty database and will skip steps that are not needed. For instance if a library already exists, the first step will be skipped. One of the main problem was the lack of feedback messages sent to the user when something wrong/ok happened. Explanation on main changes: 1. Use checkauth first, then get_template_and_user => As we do not know the template to use, it's better to use checkauth first to know if the user is logged in, then retrieve the template we need, depending on the success or the failure of the action 2. Create a @messages variables Pushing messages to this variable and handling the messages via an include files (onboarding_messages.inc) simplify error handling. Note that we could remove this include file if we merge all the onboardingstepX.tt files altogether 3. Simplify creation of the admnistrator user This patch removes some unecessary checks done on the user's info (passwd to short, mandatory fields Todo (minor): Add style to feedback messages Signed-off-by: Alex Buckley <alexbuckley@catalyst.net.nz> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> Bug 17942 - Update style of the web installer with Bootstrap 3 This patch makes style and markup changes to the web installer and new onboarding tool (Bug 17855). - Markup has been corrected, improved, and in many places reindented. - Some page titles have been made more specific. - Some JavaScript and CSS have been moved to separate files. In the onboarding tool I have removed form validation from the markup and JavaScript in many cases where the requirements were not matched elsewhere in Koha. For instance, we shouldn't limit item type descriptions to only letters because the database doesn't require such a limit. To test, apply the patch and run the web installer with an empty database. Confirm that the installation process completes correctly and that each page looks good and works correctly. Signed-off-by: Josef Moravec <josef.moravec@gmail.com> Signed-off-by: Liz Rea <liz@catalyst.net.nz> https://bugs.koha-community.org/show_bug.cgi?id=18462 Bug 17942 - Add anti-clickjack code to installer doc head close
Created attachment 62428 [details] [review] Bug 18462 - Merged patches on bugs 17855 and 17942 to implemented the bootstrap styling onto the web installer and newly altered onboarding tool.
Created attachment 62429 [details] [review] Bug 18462 - Changed the position of installer strings on the onboarding screens
Created attachment 62430 [details] [review] Bug 18462 - Changed the display of the <h2> in the onboardinstep5.tt and the location of the onboarding string in onboardingstep3.tt
Created attachment 62513 [details] [review] Bug 18462 - Implemented the div id="breadcrumbs" around the further information for how to create libraries, patron categories, patrons, item types, and circulation rules
Note the styling work in these patches is from Owen Leonard's excellent work in bug 17942. However since the onboarding tool (bug 17855) has changed so much since bug 17942 was completed I have had to do a fairly significant amount of manual implementation of the styling based on bug 17942. I am referencing Owen's work because I want him to get the credit for the styling I just integrated it with the onboarding tool.
Test plan: Go through the web installer and onboarding tool (note you do not need to apply bug 17855 as I have included it in the patches attached to this bug report) and notice that bootstrap styling is being used throughout the whole installation process (Web installer and onboarding tool)
Sorry again, I get a merge conflict: Wende an: Bug 17855: Onboarding tool Verwende Informationen aus der Staging-Area, um einen Basisverzeichnis nachzustellen M installer/install.pl M koha-tmpl/intranet-tmpl/prog/en/modules/installer/step3.tt Falle zurück zum Patchen der Basis und des 3-Wege-Merges... automatischer Merge von koha-tmpl/intranet-tmpl/prog/en/modules/installer/step3.tt KONFLIKT (Inhalt): Merge-Konflikt in koha-tmpl/intranet-tmpl/prog/en/modules/installer/step3.tt automatischer Merge von installer/install.pl KONFLIKT (Inhalt): Merge-Konflikt in installer/install.pl
Created attachment 62683 [details] [review] Bug 17855: Onboarding tool Tested 3 patches together on current master - Dropped database - Recreated database - Went through installer - Language en, Marc21 - Installed mandatory data only - Went through Onboarding tool - After finishing, logged in as superlibrarian that was created by onboarding tool Everything worked fine. Signed-off-by: Marc Véron <veron@veron.ch> Signed-off-by: Marc Véron <veron@veron.ch> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
Created attachment 62684 [details] [review] Bug 17855 - Reverted back to original step 3 in the web installer so there is no basic and advanced setup mode and consequently no need for SQL files to be moved to a 'default' directory for all languages. Onboarding tool and the rest of the web installer still exists in this commit How I tested in my VM (Current master): - Dropped database - Recreated database - Went through installer - Language en, Marc21 - Installed mandatory data only - Went through Onboarding tool - After finishing, logged in as superlibrarian that was created by onboarding tool Everything worked fine. Signed-off-by: Marc Véron <veron@veron.ch> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> Bug 17855 - Followup patch following requests in comments 176 and 177 Signed-off-by: Marc Véron <veron@veron.ch> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> Bug 17855: perltidy onboarding.pl Signed-off-by: Alex Buckley <alexbuckley@catalyst.net.nz> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> Bug 17855: Do not create a new dbh, get it from C4::Context->dbh Signed-off-by: Alex Buckley <alexbuckley@catalyst.net.nz> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> Bug 17855: Redirect to the installer if installation process is not done yet Signed-off-by: Alex Buckley <alexbuckley@catalyst.net.nz> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> Bug 17855: No need to resend the library list to the template This has been done at the beginning of the script Signed-off-by: Alex Buckley <alexbuckley@catalyst.net.nz> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> Bug 17855: Simplify the onboarding tool This patch should not modify a lot the behaviours of the onboarding tool. Its goal is mainly to remove duplicated as well as useless (because copy/pasted from existing script files) code. It assumes that the onboarding tool will be done on an empty database and will skip steps that are not needed. For instance if a library already exists, the first step will be skipped. One of the main problem was the lack of feedback messages sent to the user when something wrong/ok happened. Explanation on main changes: 1. Use checkauth first, then get_template_and_user => As we do not know the template to use, it's better to use checkauth first to know if the user is logged in, then retrieve the template we need, depending on the success or the failure of the action 2. Create a @messages variables Pushing messages to this variable and handling the messages via an include files (onboarding_messages.inc) simplify error handling. Note that we could remove this include file if we merge all the onboardingstepX.tt files altogether 3. Simplify creation of the admnistrator user This patch removes some unecessary checks done on the user's info (passwd to short, mandatory fields Todo (minor): Add style to feedback messages Signed-off-by: Alex Buckley <alexbuckley@catalyst.net.nz> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> Bug 17942 - Update style of the web installer with Bootstrap 3 This patch makes style and markup changes to the web installer and new onboarding tool (Bug 17855). - Markup has been corrected, improved, and in many places reindented. - Some page titles have been made more specific. - Some JavaScript and CSS have been moved to separate files. In the onboarding tool I have removed form validation from the markup and JavaScript in many cases where the requirements were not matched elsewhere in Koha. For instance, we shouldn't limit item type descriptions to only letters because the database doesn't require such a limit. To test, apply the patch and run the web installer with an empty database. Confirm that the installation process completes correctly and that each page looks good and works correctly. Signed-off-by: Josef Moravec <josef.moravec@gmail.com> Signed-off-by: Liz Rea <liz@catalyst.net.nz> https://bugs.koha-community.org/show_bug.cgi?id=18462 Bug 17942 - Add anti-clickjack code to installer doc head close
Created attachment 62685 [details] [review] Bug 18462 - Merged patches on bugs 17855 and 17942 to implemented the bootstrap styling onto the web installer and newly altered onboarding tool.
Created attachment 62686 [details] [review] Bug 18462 - Changed the position of installer strings on the onboarding screens
Created attachment 62687 [details] [review] Bug 18462 - Changed the display of the <h2> in the onboardinstep5.tt and the location of the onboarding string in onboardingstep3.tt
Created attachment 62688 [details] [review] Bug 18462 - Implemented the div id="breadcrumbs" around the further information for how to create libraries, patron categories, patrons, item types, and circulation rules
(In reply to Marc Veron in comment 11) Thanks Marc It should work now I have just fixed it and reattached the patches
Created attachment 62711 [details] [review] Bug 17855: Onboarding tool Tested 3 patches together on current master - Dropped database - Recreated database - Went through installer - Language en, Marc21 - Installed mandatory data only - Went through Onboarding tool - After finishing, logged in as superlibrarian that was created by onboarding tool Everything worked fine. Signed-off-by: Marc Véron <veron@veron.ch> Signed-off-by: Marc Véron <veron@veron.ch> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> https://bugs.koha-community.org/show_bug.cgi?id=18462 Signed-off-by: Marc Véron <veron@veron.ch>
Created attachment 62712 [details] [review] Bug 17855 - Reverted back to original step 3 in the web installer so there is no basic and advanced setup mode and consequently no need for SQL files to be moved to a 'default' directory for all languages. Onboarding tool and the rest of the web installer still exists in this commit How I tested in my VM (Current master): - Dropped database - Recreated database - Went through installer - Language en, Marc21 - Installed mandatory data only - Went through Onboarding tool - After finishing, logged in as superlibrarian that was created by onboarding tool Everything worked fine. Signed-off-by: Marc Véron <veron@veron.ch> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> Bug 17855 - Followup patch following requests in comments 176 and 177 Signed-off-by: Marc Véron <veron@veron.ch> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> Bug 17855: perltidy onboarding.pl Signed-off-by: Alex Buckley <alexbuckley@catalyst.net.nz> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> Bug 17855: Do not create a new dbh, get it from C4::Context->dbh Signed-off-by: Alex Buckley <alexbuckley@catalyst.net.nz> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> Bug 17855: Redirect to the installer if installation process is not done yet Signed-off-by: Alex Buckley <alexbuckley@catalyst.net.nz> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> Bug 17855: No need to resend the library list to the template This has been done at the beginning of the script Signed-off-by: Alex Buckley <alexbuckley@catalyst.net.nz> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> Bug 17855: Simplify the onboarding tool This patch should not modify a lot the behaviours of the onboarding tool. Its goal is mainly to remove duplicated as well as useless (because copy/pasted from existing script files) code. It assumes that the onboarding tool will be done on an empty database and will skip steps that are not needed. For instance if a library already exists, the first step will be skipped. One of the main problem was the lack of feedback messages sent to the user when something wrong/ok happened. Explanation on main changes: 1. Use checkauth first, then get_template_and_user => As we do not know the template to use, it's better to use checkauth first to know if the user is logged in, then retrieve the template we need, depending on the success or the failure of the action 2. Create a @messages variables Pushing messages to this variable and handling the messages via an include files (onboarding_messages.inc) simplify error handling. Note that we could remove this include file if we merge all the onboardingstepX.tt files altogether 3. Simplify creation of the admnistrator user This patch removes some unecessary checks done on the user's info (passwd to short, mandatory fields Todo (minor): Add style to feedback messages Signed-off-by: Alex Buckley <alexbuckley@catalyst.net.nz> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> Bug 17942 - Update style of the web installer with Bootstrap 3 This patch makes style and markup changes to the web installer and new onboarding tool (Bug 17855). - Markup has been corrected, improved, and in many places reindented. - Some page titles have been made more specific. - Some JavaScript and CSS have been moved to separate files. In the onboarding tool I have removed form validation from the markup and JavaScript in many cases where the requirements were not matched elsewhere in Koha. For instance, we shouldn't limit item type descriptions to only letters because the database doesn't require such a limit. To test, apply the patch and run the web installer with an empty database. Confirm that the installation process completes correctly and that each page looks good and works correctly. Signed-off-by: Josef Moravec <josef.moravec@gmail.com> Signed-off-by: Liz Rea <liz@catalyst.net.nz> https://bugs.koha-community.org/show_bug.cgi?id=18462 Bug 17942 - Add anti-clickjack code to installer doc head close Signed-off-by: Marc Véron <veron@veron.ch>
Created attachment 62713 [details] [review] Bug 18462 - Merged patches on bugs 17855 and 17942 to implemented the bootstrap styling onto the web installer and newly altered onboarding tool. Signed-off-by: Marc Véron <veron@veron.ch>
Created attachment 62714 [details] [review] Bug 18462 - Changed the position of installer strings on the onboarding screens
Created attachment 62715 [details] [review] Bug 18462 - Changed the display of the <h2> in the onboardinstep5.tt and the location of the onboarding string in onboardingstep3.tt Signed-off-by: Marc Véron <veron@veron.ch>
Created attachment 62716 [details] [review] Bug 18462 - Implemented the div id="breadcrumbs" around the further information for how to create libraries, patron categories, patrons, item types, and circulation rules Signed-off-by: Marc Véron <veron@veron.ch>
Tested all patches together, worked as expected (and looks great!) Switch to Signed off
I would like to add some minor follow-ups.
I do not understand how these patches have been build, but they have to be based on top of bug 17855 that is going to be pushed!
Created attachment 62737 [details] [review] Bug 18462 [Follow-up] Implemented bootstrap styling on the web installer and onboarding tool This patch adds some changes which were left out of the transfer from Bug 17942. Other general markup issues have been corrected. To test, apply the patch and run through the install and onboarding process. Each step should look correct and work correctly. HTML should validate.
*** Bug 17942 has been marked as a duplicate of this bug. ***
(In reply to Jonathan Druart in comment 27) The patches attached to this bug have been built in the following way: 1. On a new branch I applied bug 17855 (after it was passed QA) and 17942. 2. Due to such significant changes to bug 17855 since 17942 was last worked on I had to manually write in much of the styling markup onto the onboardingstep*.tt files. Therefore this patch is based on 17855 after it was Passed QA
Amazing, looks really very nice! I went several times through the installation process and gathered some remarks, mostly about wording / capitalisation. While testing I tried to take the perspective of a newbie in first contact to Koha. ---- Step "Web installer > setup > Select default settings" Capitalisation of 'setup' (Setup) Capitalisation of "Default MARC 21 Standard Authority Types" (Standard Authoriyty types? Standard authority types?) Mandatory data are not selected by default. Is that by design? Maybe because minimal data will be covered later by the onboarding tool? Maybe there could be a hint that minimal data can be defined later as well, with the onboarding tool. (Oh, without creating a default framework here we will later have an empty, not editable default framework in Home > Administration > MARC frameworks ) There is one link to toggle all selections ('select all'). Would it be better to have one link to toggle all mandatory data and one to toggle all non-mandatory data? ------ Step "Default data loaded We have here the message "All done! Installaton complete." Sounds like a final message, but we will have to do more steps... Maybe something like: "Basic installation complete" as title and a little explanation what's do come: "In the next steps you will be guided through some basic requirements like having a Koha user with all administrative privileges (superlibrarian)." Information about sharing statistics: ------ Step "Create a patron category Enrolment period, after the field "In months:" "Please choose an enrollment period in months OR by date. months" Trailing 'months' is confusing and not necessary because we have it already in the label. ----- Step "Create Koha administator patron" Password strenght: A password like '1' is accepted! "To give the new patron superlibrarian permissions go to: More > Set Permissions:" Capitalisation of "Permissions", should be lower case. We have two 'More' on the staff surface, one in the main menu and one in the menu for editing patrons. That can be confusing for newbies. Maybe the wording can be clarified here, something like: "To create more patrons, go to:" "To give patrons superlibrarian permissions on their detail pages go to:" (That would avoid a possible misunderstanding as well, first I understood it that I would have to set permissions for the administrator account that's about to be createt here) ----- Step "Create a new item type" "Importantly item types are what..." sounds odd in my (not native speaker's) ear. Maybe something like "Important: Item types are what..." More > Adminstration > Circulation and Fine Rules (Capitalisation: Circulation and fine rules) We have here the 'More' from the main menu: Wording could be something like: "To create circulation rule, from the main menu go to: More > Adminstration > Circulation and fine rules" ------- Web installer > Complete "Congratulations you have finished and ready to use Koha" I suppose it should be: "Congratulations, you have finished and are ready to use Koha" "Start using Koha": I get the login dialog with a big, red, newbie scaring message: "Error: Session timed out. Please log in again." Maybe the the login dialog could display a nice welcome message if it is called from the installer's final step. Just an idea...
(In reply to Alex Buckley from comment #30) > (In reply to Jonathan Druart in comment 27) > > The patches attached to this bug have been built in the following way: > > 1. On a new branch I applied bug 17855 (after it was passed QA) and 17942. > > 2. Due to such significant changes to bug 17855 since 17942 was last worked > on I had to manually write in much of the styling markup onto the > onboardingstep*.tt files. > > Therefore this patch is based on 17855 after it was Passed QA Alex, the only thing I know is that 17855 is going to be pushed and these patches have to be based on top of it. Here the first patch is an old version of 17855 and you will get big conflicts to resolve when it will be pushed.
The way to continue here is not clear. Please jump on IRC to discuss the method.
Thanks Jonathan I'll be on irc all day so I will be available when you are
*** This bug has been marked as a duplicate of bug 17942 ***