Uploaded image for project: 'IGB'
  1. IGB
  2. IGBF-3981

Create a documentation to use sdkman

    Details

    • Type: Documentation
    • Status: Closed (View Workflow)
    • Priority: Minor
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:
      None

      Description

      SDKMAN is a tool for managing parallel Versions of multiple Software Development Kits.

      Create a documentation on how to install and use sdkman.

        Attachments

          Activity

          uchinta Udaya Chinta created issue -
          uchinta Udaya Chinta made changes -
          Field Original Value New Value
          Rank Ranked higher
          nfreese Nowlan Freese made changes -
          Epic Link IGBF-1531 [ 17617 ]
          nfreese Nowlan Freese made changes -
          Issue Type Task [ 3 ] Documentation [ 12 ]
          nfreese Nowlan Freese made changes -
          Sprint Fall 6 [ 207 ]
          uchinta Udaya Chinta made changes -
          Story Points 1
          uchinta Udaya Chinta made changes -
          Status To-Do [ 10305 ] In Progress [ 3 ]
          Hide
          uchinta Udaya Chinta added a comment - - edited

          Created the below SDKMAN documentation. Please verify and let me know if any changes required
          https://wiki.bioviz.org/confluence/display/igbdevelopers/SDKMAN+Installation+and+Usage+Guide
          Cc : Ann Loraine

          Show
          uchinta Udaya Chinta added a comment - - edited Created the below SDKMAN documentation. Please verify and let me know if any changes required https://wiki.bioviz.org/confluence/display/igbdevelopers/SDKMAN+Installation+and+Usage+Guide Cc : Ann Loraine
          uchinta Udaya Chinta made changes -
          Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
          uchinta Udaya Chinta made changes -
          Assignee Udaya Chinta [ uchinta ]
          Hide
          ann.loraine Ann Loraine added a comment - - edited

          I think the documentation is very clear and easy to follow. It only addresses using sdkman on windows platform, but I think this is OK, since it is pretty easy to install sdkman on Unix-based systems.

          I would recommend one change: At the beginning of the page, I suggest providing some introductory text that explains that skdman is useful for managing and switching between different Java versions.

          Also, I think it would be good to let users know where they can find out which particular SDK they need to install.

          If you feel these are useful and good suggestions, please go ahead and update the documentation as you see fit.

          Show
          ann.loraine Ann Loraine added a comment - - edited I think the documentation is very clear and easy to follow. It only addresses using sdkman on windows platform, but I think this is OK, since it is pretty easy to install sdkman on Unix-based systems. I would recommend one change: At the beginning of the page, I suggest providing some introductory text that explains that skdman is useful for managing and switching between different Java versions. Also, I think it would be good to let users know where they can find out which particular SDK they need to install. If you feel these are useful and good suggestions, please go ahead and update the documentation as you see fit.
          ann.loraine Ann Loraine made changes -
          Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
          ann.loraine Ann Loraine made changes -
          Status First Level Review in Progress [ 10301 ] To-Do [ 10305 ]
          ann.loraine Ann Loraine made changes -
          Assignee Udaya Chinta [ uchinta ]
          uchinta Udaya Chinta made changes -
          Status To-Do [ 10305 ] In Progress [ 3 ]
          Hide
          uchinta Udaya Chinta added a comment -

          Thank you for your suggestions. I will add an introductory section about SDKMAN. I’ve added commands to help users find the specific SDK they need to install. I’ll work on updating the documentation to make it clearer so users can easily locate the available SDK versions.

          Show
          uchinta Udaya Chinta added a comment - Thank you for your suggestions. I will add an introductory section about SDKMAN. I’ve added commands to help users find the specific SDK they need to install. I’ll work on updating the documentation to make it clearer so users can easily locate the available SDK versions.
          Hide
          uchinta Udaya Chinta added a comment -

          Please review the updated documentation.
          Cc : Ann Loraine

          Show
          uchinta Udaya Chinta added a comment - Please review the updated documentation. Cc : Ann Loraine
          uchinta Udaya Chinta made changes -
          Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
          uchinta Udaya Chinta made changes -
          Assignee Udaya Chinta [ uchinta ]
          pkulzer Paige Kulzer made changes -
          Assignee Ann Loraine [ aloraine ]
          ann.loraine Ann Loraine made changes -
          Sprint Fall 6 [ 207 ] Fall 6, Fall 7 [ 207, 208 ]
          ann.loraine Ann Loraine made changes -
          Rank Ranked higher
          ann.loraine Ann Loraine made changes -
          Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
          Hide
          ann.loraine Ann Loraine added a comment -

          I think this is documentation is great. I am moving this to Done. Thank you Udaya Chinta!

          Show
          ann.loraine Ann Loraine added a comment - I think this is documentation is great. I am moving this to Done. Thank you Udaya Chinta !
          ann.loraine Ann Loraine made changes -
          Status First Level Review in Progress [ 10301 ] Ready for Pull Request [ 10304 ]
          ann.loraine Ann Loraine made changes -
          Status Ready for Pull Request [ 10304 ] Pull Request Submitted [ 10101 ]
          ann.loraine Ann Loraine made changes -
          Status Pull Request Submitted [ 10101 ] Reviewing Pull Request [ 10303 ]
          ann.loraine Ann Loraine made changes -
          Status Reviewing Pull Request [ 10303 ] Merged Needs Testing [ 10002 ]
          ann.loraine Ann Loraine made changes -
          Status Merged Needs Testing [ 10002 ] Post-merge Testing In Progress [ 10003 ]
          ann.loraine Ann Loraine made changes -
          Resolution Done [ 10000 ]
          Status Post-merge Testing In Progress [ 10003 ] Closed [ 6 ]
          ann.loraine Ann Loraine made changes -
          Assignee Ann Loraine [ aloraine ] Udaya Chinta [ uchinta ]

            People

            • Assignee:
              uchinta Udaya Chinta
              Reporter:
              uchinta Udaya Chinta
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: