Add new fields to WINS Display Review and _wins-data.json

[roslynwythe]

Dependency

• Create wiki page "Hfla Google Apps Script Development/Review Process" #4134

Overview

We need to create new fields to hold only GitHub and LinkedIn handles (in contrast to the current fields which contain complete URLs), and to incorporate those fields into the Response sheet, Review sheet, and the _wins-data.json feed.

Details

We set up validation on the wins form so that users could give us the handles, with and without URL prefixes, now we need to take only the handle into the relevant sheets, so that we can (in another issue) update the .js files.

Ultimately, the goal is to have the URLs on the wins page (you can see them when you hover over the LinkedIn and GitHub icons), have a standard format. See epic for more details.

Action Items

• This issue will require modification of the code the Apps Script wins-form-responses within the Wins-form (responses)¹ sheet, but you will require a Google Drive test environment that includes copies of Wins-form (Responses)¹, gh-requests², and Wins-form[^6]. It will also be useful to read Wins Form Admin Guide³. It will also be necessary to setup a test environment in your GitHub repository. Follow instructions in the comment in the Hfla Google Apps Script Development Process Guide⁴ and Testing WINS in a test repository⁵
• As described in section 3a and 3b of the Hfla Google Apps Script Development Process Guide⁴, you will provide a dev lead with the google account you wish to use for testing, and request the dev lead to:
  • do not modify folder level access
  • share the Wins Form Admin Guide³ as VIEWER
  • share the Wins-form (Responses)¹ sheet as VIEWER
  • share the gh-requests doc as VIEWER
  • make a copy of Wins-form, including the issue # in the name, then share that copy with the developer as EDITOR.
• Continue following instructions in 3c and d. As described in 3d, you will have to make modifications to certain documents in the test folder.
  • In the test folder, you must edit the Responses settings of the Wins-form so that test submissions will be stored in the Wins-form (Responses} that is in the test environment
  • Setup triggers so that insertLatestFormSubmitIntoReviewSheet and createIssue functions will execute when a form is submitted
  • Since you will be running main() for testing, you must follow instructions in Testing WINS in a test repository
• Continue following instructions through section 6 "Editing". As described in this section, editing can be done locally in an IDE or in the Google Drive cloud editor, and the clasp utility can be used to transfer code back and forth between the local worksation and the Google Drive as needed.
• In the Response sheet, create two new columns GitHub-handle and LinkedIn-name
• In insertLatestFormSubmitIntoReviewSheet populate the new columns with strings extracted from the submitted data in the GitHub URL and LinkedIn URL columns in the Response sheet.
• Display the values of GitHub-handle and LinkedIn-name, along with the submitted data for GitHub URL and LinkedIn URL, on the Review sheet.
• In main add code to include the GitHub-handle and LinkedIn-name fields in _wins-data.json
• Refer to Section 7 "Testing" in the Hfla Google Apps Script Development Process Guide⁴ , Test the code by running main() in debug mode. A new pull request "Update wins-data.json via Google Apps Script" should be appear in your test repository. Examine the json data and if it looks good, merge into your repository test branch, bring that branch down to your local workstation and and use Docker to examine the resulting Wins page, which should remain unchanged.
• Refer to Section 8 "Completing an Issue" in the Hfla Google Apps Script Development Process Guide⁴ , for information about commiting Code.js and creating a pull request.
• In the pull request, provide links to the "Update wins-data.json via Google Apps Script" Pull Request and also the Wins page (both in your repository), for the convenience of reviewers.
• Contact a dev lead to discuss review/demonstration

Resources/Instructions

• This issue is part of Epic: Change to Wins Form, Apps Script and JS to implement new URL validation strategy #4671
• Wins data (json)
• Wins webpage
• wins.html
• Wins js

Footnotes

1. Wins-form (Response) Sheet ↩ ↩² ↩³

2. gh-requests ↩

3. Wins Form Admin Guide ↩ ↩²

4. Hfla Google Apps Script Development Process Guide - draft ↩ ↩² ↩³ ↩⁴

5. Testing WINS in a test repository ↩