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

Inventory "help" links and their targets in App Store

    Details

    • Type: Task
    • Status: Closed (View Workflow)
    • Priority: Major
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:
      None
    • Story Points:
      0.5
    • Sprint:
      Winter 1 Dec 28 - Jan 8, Winter 2 Jan 11 - Jan 22, Winter 3 Jan 25 - Feb 5, Winter 4 Feb 8 - Feb 19, Winter 5 Feb 22 - Mar 5

      Description

      We need to do a better job of providing organized, easy-to-find and easy-to-understand developer documentation for the App Store.

      To start, we need an organized inventory of all developer help links.

      For this task, walk through the process of uploading an App. As you go, make a note of each help-related link. Report the context of the link and report the URL that it currently points to.

      We will use this overview document to re-organize & streamline all our developer documentation to improve the developer experience of creating and submitting Apps.

        Attachments

          Activity

          Show
          ssegu Sai Supreeth Segu added a comment - Please find the link for the spreadsheet: https://docs.google.com/spreadsheets/d/1dzSGxHo7dKXMcbEn0X8VCcMlqO2oEIuRqTDtbzLSEg0/edit#gid=0
          Hide
          ssegu Sai Supreeth Segu added a comment - - edited

          I have found that developer's document link in tooltip is not working in both error and confirm page.
          I have updated the link and created a branch for the change. Please review my changes.
          Link for the branch: https://bitbucket.org/supreeth27/appstore/branch/IGBF-2739#diff
          cc: Dr. Ann Loraine

          Show
          ssegu Sai Supreeth Segu added a comment - - edited I have found that developer's document link in tooltip is not working in both error and confirm page. I have updated the link and created a branch for the change. Please review my changes. Link for the branch: https://bitbucket.org/supreeth27/appstore/branch/IGBF-2739#diff cc: Dr. Ann Loraine
          Hide
          aloraine Ann Loraine added a comment -

          Please submit PR

          Show
          aloraine Ann Loraine added a comment - Please submit PR
          Show
          ssegu Sai Supreeth Segu added a comment - - edited Please review my pull request: https://bitbucket.org/supreeth27/appstore/pull-requests/1/igbf-2739-updating-developers-document cc: Dr. Ann Loraine
          Hide
          aloraine Ann Loraine added a comment -

          Please check PR target. It is currently not pointing to the team repo.

          Show
          aloraine Ann Loraine added a comment - Please check PR target. It is currently not pointing to the team repo.
          Show
          ssegu Sai Supreeth Segu added a comment - Please review my pull request: https://bitbucket.org/lorainelab/appstore/pull-requests/266/igbf-2739-updating-developers-document cc: Dr. Ann Loraine
          Hide
          aloraine Ann Loraine added a comment -

          Merged but not yet deployed to devappstore(s).

          Show
          aloraine Ann Loraine added a comment - Merged but not yet deployed to devappstore(s).
          Hide
          aloraine Ann Loraine added a comment - - edited

          For next steps, make a google doc or slides with screen grabs showing context for each help-related link. Also show also a screen grab of where the link currently leads.

          This will help us understand what new content, if any, is required.

          Kindly do this for every screen where a link out to an external site exists, but NOT for the "Other Resources" section on individual App Pages. (These links are configured by users.)

          Please use https://devappstore3.bioviz.org for this.
          Edit this Google Slides document: https://docs.google.com/presentation/d/1NMNcbsO_-pKyA0Q9s4KiLT5_KP4wrW9v6lHFEgOKrtw/edit?usp=sharing
          Save any related digitla assets in the containing folder for the above document: https://drive.google.com/drive/folders/1WdjHvQjosk_L46-4dtpvKL84FOTHlIbs?usp=sharing

          Please edit this Google Slides document:

          Show
          aloraine Ann Loraine added a comment - - edited For next steps, make a google doc or slides with screen grabs showing context for each help-related link. Also show also a screen grab of where the link currently leads. This will help us understand what new content, if any, is required. Kindly do this for every screen where a link out to an external site exists, but NOT for the "Other Resources" section on individual App Pages. (These links are configured by users.) Please use https://devappstore3.bioviz.org for this. Edit this Google Slides document: https://docs.google.com/presentation/d/1NMNcbsO_-pKyA0Q9s4KiLT5_KP4wrW9v6lHFEgOKrtw/edit?usp=sharing Save any related digitla assets in the containing folder for the above document: https://drive.google.com/drive/folders/1WdjHvQjosk_L46-4dtpvKL84FOTHlIbs?usp=sharing Please edit this Google Slides document:
          Hide
          aloraine Ann Loraine added a comment - - edited

          Rachel Weidenhammer - the links on slides 4 through 11 are all user-configurable and are not "help" style links. By "help style," I mean: links to resources explaining to app developers how to use the App Store and how to solve problems they may encounter.
          None of those links are under our control – they are added and configured by the user who submits the app.
          None of these links is actually holding us back from releasing App Store.
          What I actually need are links to App Store documentation that appear when a user uploads an App.
          Chirag Chandrahas Shetty - Can you help? Please show Rachel Weidenhammer how to upload an App and all the links that appear during that process, including links embedded in tooltips.

          Show
          aloraine Ann Loraine added a comment - - edited Rachel Weidenhammer - the links on slides 4 through 11 are all user-configurable and are not "help" style links. By "help style," I mean: links to resources explaining to app developers how to use the App Store and how to solve problems they may encounter. None of those links are under our control – they are added and configured by the user who submits the app. None of these links is actually holding us back from releasing App Store. What I actually need are links to App Store documentation that appear when a user uploads an App. Chirag Chandrahas Shetty - Can you help? Please show Rachel Weidenhammer how to upload an App and all the links that appear during that process, including links embedded in tooltips.
          Hide
          aloraine Ann Loraine added a comment -

          I am going to add some now.

          Show
          aloraine Ann Loraine added a comment - I am going to add some now.
          Hide
          rweidenh Rachel Weidenhammer (Inactive) added a comment -

          Slideshow: https://docs.google.com/presentation/d/1NMNcbsO_-pKyA0Q9s4KiLT5_KP4wrW9v6lHFEgOKrtw/edit#slide=id.gbff5dac981_1_80

          I have added slides for the pages a developer could come across when submitting an app, the help links present, and where they link out to.

          Below that are a series of screen grabs of app submission success and error page messages.

          The last section is of the individual app page and it's links.

          Show
          rweidenh Rachel Weidenhammer (Inactive) added a comment - Slideshow: https://docs.google.com/presentation/d/1NMNcbsO_-pKyA0Q9s4KiLT5_KP4wrW9v6lHFEgOKrtw/edit#slide=id.gbff5dac981_1_80 I have added slides for the pages a developer could come across when submitting an app, the help links present, and where they link out to. Below that are a series of screen grabs of app submission success and error page messages. The last section is of the individual app page and it's links.

            People

            • Assignee:
              rweidenh Rachel Weidenhammer (Inactive)
              Reporter:
              aloraine Ann Loraine
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: