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

Create README.md for Hello World App

        Details

        • Type: New Feature
        • Status: Closed (View Workflow)
        • Priority: Major
        • Resolution: Done
        • Affects Version/s: None
        • Fix Version/s: None
        • Labels:

          Description

          We have a very simple App called Hello World App that is version-controlled in bitbucket. It's meant to illustrate how a developer can add a new menu item to IGB.

          Repository link: https://bitbucket.org/lorainelab/hello-world-igb-app/src/master/

          However, it lacks a README.md file. We should create one that summarizes the purpose and functionality of App.

          We need explain to the user/developer where the App will appear once it's added, i.e., which menu it gets added to.

          Note that the README.md will be base-64 encoded and included in the OBR index file created for the App. Search Jira for details.

            Attachments

              Activity

              Ascending order - Click to sort in descending order
              Hide
              Permalink
              shamika Shamika Gajanan Kulkarni (Inactive) added a comment -

              The README.md file has been added. The changes are present in the link below. Kindly review and please let me know if any changes are to be made in the description or elsewhere.
              https://bitbucket.org/lorainelab/hello-world-igb-app/branch/IGBF-1903#diff

              Show
              shamika Shamika Gajanan Kulkarni (Inactive) added a comment - The README.md file has been added. The changes are present in the link below. Kindly review and please let me know if any changes are to be made in the description or elsewhere. https://bitbucket.org/lorainelab/hello-world-igb-app/branch/IGBF-1903#diff
              Hide
              Permalink
              ann.loraine Ann Loraine added a comment -

              Looks good! Feel free to submit pull request and merge it when you get back!

              Show
              ann.loraine Ann Loraine added a comment - Looks good! Feel free to submit pull request and merge it when you get back!
              Hide
              Permalink
              shamika Shamika Gajanan Kulkarni (Inactive) added a comment -

              Pull request submitted for the same... Please let me know if I should be merging it too...
              https://bitbucket.org/lorainelab/hello-world-igb-app/pull-requests/1/igbf-1903-add-readmemd-to-app/diff
              Thank you.

              Show
              shamika Shamika Gajanan Kulkarni (Inactive) added a comment - Pull request submitted for the same... Please let me know if I should be merging it too... https://bitbucket.org/lorainelab/hello-world-igb-app/pull-requests/1/igbf-1903-add-readmemd-to-app/diff Thank you.
              Hide
              Permalink
              prutha Prutha Kulkarni (Inactive) added a comment -

              Function testing has been done for the same. Installed the hello-world app in IGB and tested it. Also, the description which is there in the README.md file and the one which is shown using repository.xml in IGB is consistent.
              Moving the the ticket to Done.

              Show
              prutha Prutha Kulkarni (Inactive) added a comment - Function testing has been done for the same. Installed the hello-world app in IGB and tested it. Also, the description which is there in the README.md file and the one which is shown using repository.xml in IGB is consistent. Moving the the ticket to Done.

                People

                • Assignee:
                  shamika Shamika Gajanan Kulkarni (Inactive)
                  Reporter:
                  ann.loraine Ann Loraine
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  3 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved: