Kuali Rice Development
  1. Kuali Rice Development
  2. KULRICE-6047

Implement feedback on cleaning up install documentation

    Details

    • Type: Task Task
    • Status: Open Open
    • Priority: Major Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: Backlog
    • Component/s: Documentation
    • Labels:
    • Similar issues:
      KULRICE-6174Feedback on Installation Guide
      KULRICE-4662Clean up KEW services
      KULRICE-4066Clean up configuration system
      KULRICE-12814Clean up datasource configuration
      KULRICE-2579Clean up xml bootstrap files
      KULRICE-2444Ensure all old KEW Lookupable implementations are cleaned up and removed
      KULRICE-3021Clean up the StandardGenericXMLSearchableAttribute and related code
      KULRICE-2527Clean up document authorization API
      KULRICE-5441Focus order & clean-up needed in Kuali portal header (inherited by all KNS & KS pages)
      KULRICE-10704QuickStartTest.test_quickstart_gen_clean_install_int_tests IT failure
    • Rice Module:
      Rice Core

      Description

      1. There are 3 sets of install docs: in the wiki, linked from the download page, and the Install Guide. All of these should point to just the Install Guide for 2.0

      2. The first procedure is obviously aimed at a developer--without making that clear. We should make that clear.

      3. The scripts to install the data set default to the demo data set. The default should be the bootstrap data set.

      4. The install procedures make the assumption that Tomcat is or will be installed to run as a privileged user, which is not necessary and not good practice.

      5. Instead of putting environment variables for Tomcat in a launch script that wraps catalina.sh and other environment variables in the profile of the local user, it puts them in a global profile. The launch script is a good idea if you intend to run Tomcat as a daemon.

      6. The database load steps scatters files throughout the file system by default or example. For example, although the word default is mentioned, it is not mentioned in the step for installing the java libraries where these values can be changed, resulting in an unnecessary creation of /java/libraries.

      7. Missing from the first install procedure is the requirement to login as admin once the application is up and running. This was found in the second install procedure.

      Note: The install procedure found on the wiki through the developer link on the main documentation page for 1.0.3 is missing some information and the MySQL procedures is out of date, but is better organized than the install procedures found through the release documentation link.

        Issue Links

          Activity

          Hide
          Jessica Coltrin (Inactive) added a comment -

          many of these items are done already, but will do final review and close for rc1.

          Show
          Jessica Coltrin (Inactive) added a comment - many of these items are done already, but will do final review and close for rc1.
          Hide
          Jessica Coltrin (Inactive) added a comment -

          removing rc4 fix version since work on this isn't complete yet and can continue through release.

          Show
          Jessica Coltrin (Inactive) added a comment - removing rc4 fix version since work on this isn't complete yet and can continue through release.
          Hide
          Jessica Coltrin (Inactive) added a comment -

          This is not all going to happen for 2.0 - moving to 2.1.

          Show
          Jessica Coltrin (Inactive) added a comment - This is not all going to happen for 2.0 - moving to 2.1.
          Hide
          Grant Trudel (Inactive) added a comment -

          Although I cannot locate the first link, it may be related to the link found below (Release Documentation > Online Documentation):
          https://wiki.kuali.org/display/KULRICE/Home+%281.0.3%29

          Show
          Grant Trudel (Inactive) added a comment - Although I cannot locate the first link, it may be related to the link found below (Release Documentation > Online Documentation): https://wiki.kuali.org/display/KULRICE/Home+%281.0.3%29
          Hide
          Jessica Coltrin (Inactive) added a comment -

          moving all non-critical 2.1.3 Jiras to 2.1.4

          Show
          Jessica Coltrin (Inactive) added a comment - moving all non-critical 2.1.3 Jiras to 2.1.4
          Show
          Grant Trudel (Inactive) added a comment - - edited Found some more install guide documentation at http://www.kuali.org/rice/documentation/1.0.3/IG/default.htm Also at https://wiki.kuali.org/display/KULRICE/New+Rice+developer+quick+start and https://wiki.kuali.org/display/KULRICE/Checking+out+Rice+Project+for+Development and https://wiki.kuali.org/display/KULRICE/Installation+and+Configuration
          Hide
          Jessica Coltrin (Inactive) added a comment -

          Additional feedback from Claus:

          • Early on in the documentation explain the difference between "Standalone" and "Bundeled". (The document talks about setting up a standalone server but reader might not know what this is.)
          • What is ImpEx?
          • May want to explain why the mysql log-bin configuration is bad.
          Show
          Jessica Coltrin (Inactive) added a comment - Additional feedback from Claus: Early on in the documentation explain the difference between "Standalone" and "Bundeled". (The document talks about setting up a standalone server but reader might not know what this is.) What is ImpEx? May want to explain why the mysql log-bin configuration is bad.
          Hide
          Jessica Coltrin (Inactive) added a comment -

          removing myself as assignee

          Show
          Jessica Coltrin (Inactive) added a comment - removing myself as assignee

            People

            • Assignee:
              Unassigned
              Reporter:
              Matt Sargent
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:

                Structure Helper Panel