Wins page - hackforla/website GitHub Wiki

Wins page

Current process for wins to appear on the wins page

  • User fills out share your wins form available through the Share your wins button on the Wins page
    • Form answers go onto the response tab of a spreadsheet automatically.

    • A Google Apps Script uses the access permissions of elizabethhonest bot account and creates an issue on the project board notifying us that the new submission needs to be reviewed

      Screenshot of an issue created by the elizabethhonest bot account
      • An On form submit trigger runs a function which reformats a copy of the answer from the response tab onto the review tab in the spreadsheet for review
      • A new issue is created to let the product know that there is a wins submission review (this process needs to be updated on this page, with whatever links appropriate to how it is accomplished)
      • Submission is reviewed by product (in the spreadsheet)
      Screenshot of user response in review sheet

      image

      • If acceptable, PM marks true for show on website
      • If exceptional, PM marks true for showing on about page (this functionality might not be fully implemented yet)
      • If not acceptable, PM marks false for show on website, so that it does not show on the website. This is good for any spam.
  • The Google Apps Script uses a time-based trigger to check the spreadsheet monthly and uses the access permissions of the elizabethhonest bot account to create a pull request for rows that should be added to the data in the json file.
  • When the pull request is merged, the data in _wins-data.json file gets updated and the wins.js file uses the json file to display the data on the Wins page. (Note: we are in the process of changing how the json files are generated, so this line item might need to be reviewed and updated again if required)
  • Once a month, new wins might appear on the Wins page on website if the user entry is approved by PM and the related PR has been merged.

Resources

Note: Permissions to some of these resources might be restricted due to involvement of user data, please reach out to leads for access requests. Also, the list of resources is not comprehensive for security reasons, but the Wins form admin guide has detailed information on what resources you might need.

⚠️ **GitHub.com Fallback** ⚠️