-
-
Notifications
You must be signed in to change notification settings - Fork 843
Description
Dependency
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
Preparation:
- This issue will require modification of the code the Apps Script
wins-form-responses
within the Wins-form (responses)1 sheet, but you will require a Google Drive test environment that includes copies of Wins-form (Responses)1, gh-requests2, and Wins-form. It will also be useful to read Wins Form Admin Guide3. It will also be necessary to setup a test environment in your GitHub repository. Follow instructions in the Wins Google Apps Script Development Process4 - As described in section 2a and 2b of the Wins Google Apps Script Development Process4, you will provide a dev lead with the google account you wish to use for testing, and request the dev lead to:
- Continue following instructions in 2c and 3. As described in step 3, you will have to make modifications to certain documents in the test folder.
- In the test folder, you must edit the
Responses
settings of theWins-form
so that test submissions will be stored in the Wins-form (Responses} that is in the test environment - Setup triggers so that
insertLatestFormSubmitIntoReviewSheet
andcreateIssue
functions will execute when a form is submitted - Since you will be running
main()
for testing, you must follow instructions in section 8 of the Wins Google Apps Script Development Process4
- In the test folder, you must edit the
Changes and Testing:
- In the
Response
sheet, create two new columnsGitHub-handle
andLinkedIn-name
- In
insertLatestFormSubmitIntoReviewSheet
populate the new columns with strings extracted from the submitted data in theGitHub URL
andLinkedIn URL
columns in theResponse
sheet. - Display the values of
GitHub-handle
andLinkedIn-name
, along with the submitted data forGitHub URL
andLinkedIn URL
, on the Review sheet. - In
main
add code to include theGitHub-handle
andLinkedIn-name
fields in _wins-data.json - Refer to Section 8 "Testing" in the Wins Google Apps Script Development Process4 , 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 9 "Completing an Issue" in the Wins Google Apps Script Development Process4 , 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
Note for merging: this issue addresses new Wins submissions only. We may want to run a one-time function to populate the new columns for existing wins responses.
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
Metadata
Metadata
Assignees
Labels
Type
Projects
Status