From a7cba42fdd17465d64c314614348c3611d95ce9c Mon Sep 17 00:00:00 2001 From: widal001 Date: Fri, 14 Jul 2023 15:30:47 -0400 Subject: [PATCH 01/13] feat(milestone): Copies template for Static Site --- .../individual_milestones/static_site.md | 132 ++++++++++++++++++ 1 file changed, 132 insertions(+) create mode 100644 documentation/milestones/individual_milestones/static_site.md diff --git a/documentation/milestones/individual_milestones/static_site.md b/documentation/milestones/individual_milestones/static_site.md new file mode 100644 index 000000000..68816f981 --- /dev/null +++ b/documentation/milestones/individual_milestones/static_site.md @@ -0,0 +1,132 @@ +# Static Site with NOFO Content + +| Field | Value | +| --------------- | -------------------------------------------------------------------- | +| Document Status | Final Draft | +| Epic Link | [Issue 62](https://github.com/HHS/grants-api/issues/62) | +| Epic Dashboard | [Milestone Roadmap](https://github.com/orgs/HHS/projects/12/views/4) | +| Target Release | 2023-08-23 | +| Product Owner | Lucas Brown | +| Document Owner | Billy Daly | +| Lead Developer | Aaron Couch | +| Lead Designer | Andy Cochran | + +## Short description + +TODO + +## Goals + +### Business description & value + +TODO + +### User stories + +- As a **full-time HHS staff member**, I want: + - TODO +- As a **grantor**, I want: + - TODO +- As a **member of an HHS contractor team**, I want: + - TODO +- As an **open source contributor**, I want: + - TODO +- As a **prospective grant applicant**, I want: + - TODO + +## Technical description + +### {Sub-deliverable} + +TODO + +### Definition of done + +- [ ] The following infrastructure requirements are satisfied: + - [ ] The code needed to build and deploy the site is merged to `main` + - [ ] Site is built and hosted with the tools selected in the [Front-end Planning milestone](https://github.com/HHS/grants-equity/issues/49) + - [ ] All code quality checks set up in the [Developer Tools milestone](https://github.com/HHS/grants-equity/issues/50) are passing + - [ ] The resources required to deploy and host the site are provisioned programmatically using the framework established in the [Infrastructure-as-Code milestone](https://github.com/HHS/grants-equity/issues/123) + - [ ] Code changes are deployed using the CI/CD pipeline set up in [the Front-end CI/CD milestone](https://github.com/HHS/grants-equity/issues/58) +- [ ] The following user experience (UX) requirements are satisfied: + - [ ] Site is live and can be accessed at beta.grants.gov + - [ ] Site adopts the UI principles and framework established in the [Foundational UI milestone](https://github.com/HHS/grants-equity/issues/60) + - [ ] TODO +- [ ] The following content requirements are satisfied: + - [ ] TODO + +### Proposed metrics for measuring goals/value/definition of done + +TODO + +### Destination for live updating metrics + +Page on the public wiki. **Note:** This will likely change once we deliver [the Public Measurement Dashboard milestone](../milestone_short_descriptions.md#public-measurement-dashboards) + +## Planning + +### Assumptions & dependencies + + +*What capabilities / milestones do we expect to be in place at the beginning of work on this milestone?* + +TODO + +*Are there any notable capabilities / milestones do NOT we expect to be in place at the beginning of work on this milestone?* + +- [x] **Internationalization:** While there will be content delivered within this milestone that needs to be translated in the future, we do not expect to have a framework for managing translations set up by the time this milestone is delivered. + +### Open questions + + +- [x] None + +### Not doing + + +*The following work will* not *be completed as part of this milestone:* + +1. **Translating onboarding documents:** Translation of key documents will be covered in an upcoming milestone + +## Integrations + +### Translations + + +*Does this milestone involve delivering any content that needs translation?* + +*If so, when will English-language content be locked? Then when will translation be started and completed?* + +TODO + +### Services going into PROD for the first time + + +*This can include services going into PROD behind a feature flag that is not turned on.* + +TODO + +### Services being integrated in PROD for the first time + + +*Are there multiple services that are being connected for the first time in PROD?* + +TODO + +### Data being shared publicly for the first time + + +*Are there any fields being shared publicly that have never been shared in PROD before?* + +TODO + +### Security considerations + + +*Does this milestone expose any new attack vectors or expand the attack surface of the product?* + +TODO + +*If so, how are we addressing these risks?* + +TODO From 7a727e9b05ec5051be83345f14e2241e97844b50 Mon Sep 17 00:00:00 2001 From: widal001 Date: Fri, 14 Jul 2023 18:02:03 -0400 Subject: [PATCH 02/13] feat(milestone): Adds short desc and goals for Static Site --- .../individual_milestones/static_site.md | 42 ++++++++++++++----- 1 file changed, 32 insertions(+), 10 deletions(-) diff --git a/documentation/milestones/individual_milestones/static_site.md b/documentation/milestones/individual_milestones/static_site.md index 68816f981..03f21fa00 100644 --- a/documentation/milestones/individual_milestones/static_site.md +++ b/documentation/milestones/individual_milestones/static_site.md @@ -1,11 +1,11 @@ -# Static Site with NOFO Content +# Static Site for Grants Equity Project | Field | Value | | --------------- | -------------------------------------------------------------------- | | Document Status | Final Draft | | Epic Link | [Issue 62](https://github.com/HHS/grants-api/issues/62) | | Epic Dashboard | [Milestone Roadmap](https://github.com/orgs/HHS/projects/12/views/4) | -| Target Release | 2023-08-23 | +| Target Release | 2023-09-20 | | Product Owner | Lucas Brown | | Document Owner | Billy Daly | | Lead Developer | Aaron Couch | @@ -13,13 +13,20 @@ ## Short description -TODO +Launch a simple site at beta.grants.gov that provides static, informational content about the Grants Equity initiative, which includes both the Grants.gov Modernization and NOFO Transformation workstreams. ## Goals ### Business description & value -TODO +The launch of a static site for the Grants Equity project represents the culmination of multiple internally focused deliverables and serves as a landing page where key stakeholders can access information about the project. + +By sharing this information in a publicly accessible format and investing early in the infrastructure used to host it, this site aims to demonstrate the following value propositions: + +- Raising awareness about the Grants Equity project, its priorities, and ongoing workstreams +- Establishing beta.grants.gov as the primary location that stakeholders can visit for project updates and previews of deliverables from each of the workstreams +- Proving the succesful completion of technical milestones that enable faster development without sacrificing code quality or security +- Delivering an early win that both internal and external stakeholders can rally around, which helps build momentum and enthusiam for the project ### User stories @@ -44,16 +51,22 @@ TODO - [ ] The following infrastructure requirements are satisfied: - [ ] The code needed to build and deploy the site is merged to `main` - - [ ] Site is built and hosted with the tools selected in the [Front-end Planning milestone](https://github.com/HHS/grants-equity/issues/49) + - [ ] The site is built and hosted with the tools selected in the [Front-end Planning milestone](https://github.com/HHS/grants-equity/issues/49) - [ ] All code quality checks set up in the [Developer Tools milestone](https://github.com/HHS/grants-equity/issues/50) are passing - [ ] The resources required to deploy and host the site are provisioned programmatically using the framework established in the [Infrastructure-as-Code milestone](https://github.com/HHS/grants-equity/issues/123) - [ ] Code changes are deployed using the CI/CD pipeline set up in [the Front-end CI/CD milestone](https://github.com/HHS/grants-equity/issues/58) - [ ] The following user experience (UX) requirements are satisfied: - - [ ] Site is live and can be accessed at beta.grants.gov - - [ ] Site adopts the UI principles and framework established in the [Foundational UI milestone](https://github.com/HHS/grants-equity/issues/60) - - [ ] TODO + - [ ] Anyone can access a live version of the site at beta.grants.gov + - [ ] The site adopts the UI principles and framework established in the [Foundational UI milestone](https://github.com/HHS/grants-equity/issues/60) + - [ ] The site is 508 compliant and satisfies the other guidelines outlined in the Accessibility Planning milestone - [ ] The following content requirements are satisfied: - - [ ] TODO + - [ ] The site contains information about both the NOFO Transformation and Grants.gov Modernization workstreams + - [ ] The content on the site has been been reviewed and approved by the relevant stakeholders within each workstream + - [ ] The site also links to external resources related to the project, including: + - [ ] The legacy grants.gov site + - [ ] The open source repository + - [ ] The open source wiki + - [ ] The open source chat ### Proposed metrics for measuring goals/value/definition of done @@ -70,11 +83,20 @@ Page on the public wiki. **Note:** This will likely change once we deliver [the *What capabilities / milestones do we expect to be in place at the beginning of work on this milestone?* -TODO +- [ ] **Onboard Developer Team:** +- [ ] **Front-end Planning:** +- [ ] **Developer Tools:** +- [ ] **beta.grants.gov Domain:** +- [ ] **Authority to Operate (ATO):** +- [ ] **Infrastructure-as-Code:** +- [ ] **Front-end CI/CD:** +- [ ] **Foundational UI:** *Are there any notable capabilities / milestones do NOT we expect to be in place at the beginning of work on this milestone?* - [x] **Internationalization:** While there will be content delivered within this milestone that needs to be translated in the future, we do not expect to have a framework for managing translations set up by the time this milestone is delivered. +- [x] **Web Analytics:** While it may be advantageous to set up some basic page analytics to track site traffic, we do not expect to have web analytics fully configured in time for the launch of the initial static site. +- [x] **CMS:** While in the long-term we may want to support a Content Management Service (CMS) that allows non-technical users to update and manage copy for the website, we do not expect a CMS to be selected and implemented when we launch this site. ### Open questions From 7bf15b08b39b1c02847eec95acf28e4b5763c8b3 Mon Sep 17 00:00:00 2001 From: widal001 Date: Fri, 21 Jul 2023 17:31:14 -0400 Subject: [PATCH 03/13] feat(milestone): Adds sections to Static Site Adds content to the following sections: - Integration - Planning --- .../individual_milestones/static_site.md | 63 ++++++++++++------- 1 file changed, 41 insertions(+), 22 deletions(-) diff --git a/documentation/milestones/individual_milestones/static_site.md b/documentation/milestones/individual_milestones/static_site.md index 03f21fa00..2d164b32a 100644 --- a/documentation/milestones/individual_milestones/static_site.md +++ b/documentation/milestones/individual_milestones/static_site.md @@ -2,7 +2,7 @@ | Field | Value | | --------------- | -------------------------------------------------------------------- | -| Document Status | Final Draft | +| Document Status | Accepted | | Epic Link | [Issue 62](https://github.com/HHS/grants-api/issues/62) | | Epic Dashboard | [Milestone Roadmap](https://github.com/orgs/HHS/projects/12/views/4) | | Target Release | 2023-09-20 | @@ -21,12 +21,12 @@ Launch a simple site at beta.grants.gov that provides static, informational cont The launch of a static site for the Grants Equity project represents the culmination of multiple internally focused deliverables and serves as a landing page where key stakeholders can access information about the project. -By sharing this information in a publicly accessible format and investing early in the infrastructure used to host it, this site aims to demonstrate the following value propositions: +By sharing this information in a publicly accessible format and investing early in the infrastructure used to host it, this milestone aims to demonstrate the following value propositions: -- Raising awareness about the Grants Equity project, its priorities, and ongoing workstreams -- Establishing beta.grants.gov as the primary location that stakeholders can visit for project updates and previews of deliverables from each of the workstreams -- Proving the succesful completion of technical milestones that enable faster development without sacrificing code quality or security -- Delivering an early win that both internal and external stakeholders can rally around, which helps build momentum and enthusiam for the project +- Raises awareness about the Grants Equity project, its priorities, and ongoing workstreams +- Establishes beta.grants.gov as the primary location that stakeholders can visit for project updates and previews of deliverables from each of the workstreams +- Proves the succesful completion of technical milestones that enable faster development without sacrificing code quality or security +- Delivers an early win that both internal and external stakeholders can rally around, which helps build momentum and enthusiam for the project ### User stories @@ -67,10 +67,16 @@ TODO - [ ] The open source repository - [ ] The open source wiki - [ ] The open source chat + - [ ] Stretch goal:The site provides a mechanism to collect stakeholder feedback or questions ### Proposed metrics for measuring goals/value/definition of done -TODO +1. Number of unique site visitors +2. Total number of site visits +3. Number of form responses +4. Uptime service +5. [Lighthouse score](lighthouse) for the site +6. Deployment build time ### Destination for live updating metrics @@ -83,19 +89,18 @@ Page on the public wiki. **Note:** This will likely change once we deliver [the *What capabilities / milestones do we expect to be in place at the beginning of work on this milestone?* -- [ ] **Onboard Developer Team:** -- [ ] **Front-end Planning:** -- [ ] **Developer Tools:** -- [ ] **beta.grants.gov Domain:** -- [ ] **Authority to Operate (ATO):** -- [ ] **Infrastructure-as-Code:** -- [ ] **Front-end CI/CD:** -- [ ] **Foundational UI:** +- [ ] **Front-end Planning:** Determines the language, framework, and deployment service used to build and host the site. +- [ ] **Developer Tools:** Establishes a suite of tools used to ensure the quality and security of the API codebase. +- [ ] **beta.grants.gov Domain:** Secures access to the `beta.grants.gov` domain which is where the site will be hosted. +- [ ] **Authority to Operate (ATO):** Ensures that the site and the infrastructure that hosts it are comply with the Software Security Plan for the legacy grants.gov site. +- [ ] **Infrastructure-as-Code:** Programmatically provisions the resources needed to deploy and host this site. +- [ ] **Front-end CI/CD:** Sets up a CI/CD pipeline that will be used to test and publish code changes to the site. +- [ ] **Foundational UI:** Determines the UI framework that the site will adopt before launch. +- [ ] **Web Analytics:** Enables tracking key success metrics for this milestone, e.g. site traffic and number of unique visitors. *Are there any notable capabilities / milestones do NOT we expect to be in place at the beginning of work on this milestone?* - [x] **Internationalization:** While there will be content delivered within this milestone that needs to be translated in the future, we do not expect to have a framework for managing translations set up by the time this milestone is delivered. -- [x] **Web Analytics:** While it may be advantageous to set up some basic page analytics to track site traffic, we do not expect to have web analytics fully configured in time for the launch of the initial static site. - [x] **CMS:** While in the long-term we may want to support a Content Management Service (CMS) that allows non-technical users to update and manage copy for the website, we do not expect a CMS to be selected and implemented when we launch this site. ### Open questions @@ -109,6 +114,7 @@ Page on the public wiki. **Note:** This will likely change once we deliver [the *The following work will* not *be completed as part of this milestone:* 1. **Translating onboarding documents:** Translation of key documents will be covered in an upcoming milestone +2. **Legacy web analytics:** Updating the existing analytics recorded on legacy grants.gov in order to establish a baseline for comparing the site traffic for `beta.grants.gov` will happen in a later milestone ## Integrations @@ -117,38 +123,51 @@ Page on the public wiki. **Note:** This will likely change once we deliver [the *Does this milestone involve delivering any content that needs translation?* +Yes, the site contents will need to be translated. + *If so, when will English-language content be locked? Then when will translation be started and completed?* -TODO +Timeline and strategy for translation is still TBD. ### Services going into PROD for the first time *This can include services going into PROD behind a feature flag that is not turned on.* -TODO +- **Static Site:** This milestone represents the official launch of the static site +- **beta.grants.gov Domain:** The static site is the first service to officially use the `beta.grants.gov` domain +- **Stakeholder Feedback Form:** This is the first time we're collecting feedback directly from stakeholders on `beta.grants.gov` +- **Web Analytics:** This will most likely be the first service for which we are configuring web analytics ### Services being integrated in PROD for the first time *Are there multiple services that are being connected for the first time in PROD?* -TODO +- **Static Site + Feedback Form:** The feedback form should be accessible directly from the site, preferably embedded directly on the page +- **Static Site + Web Analytics:** All of the public pages on the static site should be configured to track web analytics +- **Static Site + Communications Platforms:** The static site should link to the relevant communication platforms that are available at the time of launch ### Data being shared publicly for the first time *Are there any fields being shared publicly that have never been shared in PROD before?* -TODO +- No, the content of the static site in this milestone will be limited to informational about the project or about the NOFO prototypes that have already been published on legacy grants.gov. It does not include exposing any production data from the new NOFO data model. ### Security considerations *Does this milestone expose any new attack vectors or expand the attack surface of the product?* -TODO +- **Deployment Services:** Automating our deployment process using a CI/CD platform exposes the deployment process as a potential attack vector if the deployment secrets/tokens are compromised or if malicious code through a supply chain attack. +- **Form Submissions:** While the majority of the site content will be static, accepting user input through a feedback form does expose a potential attack vector. *If so, how are we addressing these risks?* -TODO +- **Authority to Operate (ATO):** Before the official launch of the static site to the public, we will be reviewing our infrastructure and code security practices with the HHS team to ensure that they adhere to the Software Security Plan (SSP) for legacy grants.gov and are covered by the existing ATO. +- **Developer Tools:** As part of the Developer Tools milestone, the team is setting up a series of tools that will enforce certain code quality standards and security checks. These include things like secrets management, code linting, dependency monitoring, etc. +- **Form Submissions:** The implementation plan for form submissions will evaluate and consider common security practices for validating and sanitizing user input. Form submissions will also likely be stored in a system that is separate from the production database with grant data. + + +[lighthouse]: https://developer.chrome.com/en/docs/lighthouse/performance/performance-scoring/ From 37b301e1781c3b2ff09e2f99ca6df8c7fdbe6acb Mon Sep 17 00:00:00 2001 From: widal001 Date: Sun, 23 Jul 2023 16:22:04 -0400 Subject: [PATCH 04/13] feat(milestone): Adds tech description to Static Site --- .../individual_milestones/static_site.md | 49 ++++++++++++++----- 1 file changed, 37 insertions(+), 12 deletions(-) diff --git a/documentation/milestones/individual_milestones/static_site.md b/documentation/milestones/individual_milestones/static_site.md index 2d164b32a..431a4c46e 100644 --- a/documentation/milestones/individual_milestones/static_site.md +++ b/documentation/milestones/individual_milestones/static_site.md @@ -3,7 +3,7 @@ | Field | Value | | --------------- | -------------------------------------------------------------------- | | Document Status | Accepted | -| Epic Link | [Issue 62](https://github.com/HHS/grants-api/issues/62) | +| Epic Link | [Issue 62](https://github.com/HHS/grants-equity/issues/62) | | Epic Dashboard | [Milestone Roadmap](https://github.com/orgs/HHS/projects/12/views/4) | | Target Release | 2023-09-20 | | Product Owner | Lucas Brown | @@ -31,21 +31,45 @@ By sharing this information in a publicly accessible format and investing early ### User stories - As a **full-time HHS staff member**, I want: - - TODO + - the site to be accessible to members of the public and the Federal government, so we can use it to share information about the project with both internal and external stakeholders. + - the site to adopt modern branding and user interface (UI), so that stakeholders are excited to visit the page and can find the information they need more easily. - As a **grantor**, I want: - - TODO -- As a **member of an HHS contractor team**, I want: - - TODO -- As an **open source contributor**, I want: - - TODO + - to be able to access information about the NOFO Transformation project in a central location, so that I don't have to rely exclusively on email for updates about the project. + - the site to be user friendly and easy to navigate, so that I don't have to spend a lot of time looking for information that is relevant to me. - As a **prospective grant applicant**, I want: - - TODO + - the site to be user friendly and easy to navigate, so that I don't have to spend a lot of time looking for information that is relevant to me. + - an opportunity to provide feedback or ask questions about the project, so that I can voice my concerns and help shape the direction of the project. +- As **maintainer of the project** I want: + - most of the critical development infrastructure to be in place when we officially launch the site, so that we can deploy bug fixes or new features quickly once the site is live. +- As an **open source contributor**, I want: + - the site to link to resources like the repository, chat, etc., so that I can easily learn where and how to participate in the project. ## Technical description -### {Sub-deliverable} +### Infrastructure Requirements + +The infrastructure developed to deploy and host the site should balance: + +- Code quality +- Security +- Delivery velocity +- Cost & maintenance + +### User Experience Requirements + +The design and structure of the site should balance: + +- Usability +- Accessibility +- Site performance +- Brand identity + +### Content Requirements + +Process for drafting and updating the content of the site should balance: -TODO +- Speed & ease of content management +- Need for review and approval ### Definition of done @@ -67,7 +91,7 @@ TODO - [ ] The open source repository - [ ] The open source wiki - [ ] The open source chat - - [ ] Stretch goal:The site provides a mechanism to collect stakeholder feedback or questions + - [ ] Stretch goal: The site provides a mechanism to collect stakeholder feedback or questions ### Proposed metrics for measuring goals/value/definition of done @@ -77,6 +101,7 @@ TODO 4. Uptime service 5. [Lighthouse score](lighthouse) for the site 6. Deployment build time +7. Deployment/hosting costs ### Destination for live updating metrics @@ -90,7 +115,7 @@ Page on the public wiki. **Note:** This will likely change once we deliver [the *What capabilities / milestones do we expect to be in place at the beginning of work on this milestone?* - [ ] **Front-end Planning:** Determines the language, framework, and deployment service used to build and host the site. -- [ ] **Developer Tools:** Establishes a suite of tools used to ensure the quality and security of the API codebase. +- [ ] **Developer Tools:** Establishes a suite of tools used to ensure the quality and security of the site codebase. - [ ] **beta.grants.gov Domain:** Secures access to the `beta.grants.gov` domain which is where the site will be hosted. - [ ] **Authority to Operate (ATO):** Ensures that the site and the infrastructure that hosts it are comply with the Software Security Plan for the legacy grants.gov site. - [ ] **Infrastructure-as-Code:** Programmatically provisions the resources needed to deploy and host this site. From 34e5945b7d4d535b65050893ba1b7d302d108714 Mon Sep 17 00:00:00 2001 From: widal001 Date: Mon, 24 Jul 2023 09:36:39 -0400 Subject: [PATCH 05/13] feat(milestone): Links Static Site doc to short desc --- documentation/milestones/milestone_short_descriptions.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/documentation/milestones/milestone_short_descriptions.md b/documentation/milestones/milestone_short_descriptions.md index 086274d14..2ed390b92 100644 --- a/documentation/milestones/milestone_short_descriptions.md +++ b/documentation/milestones/milestone_short_descriptions.md @@ -776,11 +776,13 @@ Explore tools for unmoderated usability testing, such as: - UsabilityHub - Optimal Workshop -## Static site launch with NOFO content +## Static site launch for Grants Equity project Diagram short name: `Static-Site` Dependencies: `Beta-Domain`, `Design-Tooling`, `FE-Plan` +Milestone doc: [Static Site](./individual_milestones/static_site.md) + Launch a simple site at beta.grants.gov that provides static, informational content relevant to the NOFO simplification effort. This content could include: From ca53873bda3390967487265538e7bda7530a8627 Mon Sep 17 00:00:00 2001 From: widal001 Date: Mon, 24 Jul 2023 09:41:57 -0400 Subject: [PATCH 06/13] refactor: Updates Static-Site to executing in diagram --- documentation/milestones/milestone_dependency_diagram.mmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/milestones/milestone_dependency_diagram.mmd b/documentation/milestones/milestone_dependency_diagram.mmd index d50c2b033..022e1bc13 100644 --- a/documentation/milestones/milestone_dependency_diagram.mmd +++ b/documentation/milestones/milestone_dependency_diagram.mmd @@ -79,7 +79,7 @@ flowchart LR subgraph User interface Web-Analytics-Legacy FE-Plan::executing - FE-Plan --> Static-Site:::northStar + FE-Plan --> Static-Site:::executing FE-CI-CD FE-Plan --> FE-CI-CD FE-Plan --> CMS From 5c3b23babf9a38d521509b4d4dedea74b4e1c3b1 Mon Sep 17 00:00:00 2001 From: widal001 Date: Mon, 24 Jul 2023 15:24:10 -0400 Subject: [PATCH 07/13] fix(milestone): Feedback and typos on Static Site - Qualifies links to internal resources criterion - Fixes translation of docs bullet --- documentation/milestones/individual_milestones/static_site.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/milestones/individual_milestones/static_site.md b/documentation/milestones/individual_milestones/static_site.md index 431a4c46e..0990d695b 100644 --- a/documentation/milestones/individual_milestones/static_site.md +++ b/documentation/milestones/individual_milestones/static_site.md @@ -86,7 +86,7 @@ Process for drafting and updating the content of the site should balance: - [ ] The following content requirements are satisfied: - [ ] The site contains information about both the NOFO Transformation and Grants.gov Modernization workstreams - [ ] The content on the site has been been reviewed and approved by the relevant stakeholders within each workstream - - [ ] The site also links to external resources related to the project, including: + - [ ] The site also links to external resources related to the project (if they are available), including: - [ ] The legacy grants.gov site - [ ] The open source repository - [ ] The open source wiki @@ -138,7 +138,7 @@ Page on the public wiki. **Note:** This will likely change once we deliver [the *The following work will* not *be completed as part of this milestone:* -1. **Translating onboarding documents:** Translation of key documents will be covered in an upcoming milestone +1. **Translating site contents:** Translation of key documents will be covered in an upcoming milestone 2. **Legacy web analytics:** Updating the existing analytics recorded on legacy grants.gov in order to establish a baseline for comparing the site traffic for `beta.grants.gov` will happen in a later milestone ## Integrations From b70b695021f74c73c8bc0c5cc002dd9305020733 Mon Sep 17 00:00:00 2001 From: Billy Daly Date: Fri, 28 Jul 2023 11:03:41 -0400 Subject: [PATCH 08/13] Apply suggestions from code review Co-authored-by: Sumi <111455374+sumiat@users.noreply.github.com> --- documentation/milestones/individual_milestones/static_site.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/milestones/individual_milestones/static_site.md b/documentation/milestones/individual_milestones/static_site.md index 0990d695b..d9ed0fd79 100644 --- a/documentation/milestones/individual_milestones/static_site.md +++ b/documentation/milestones/individual_milestones/static_site.md @@ -25,7 +25,7 @@ By sharing this information in a publicly accessible format and investing early - Raises awareness about the Grants Equity project, its priorities, and ongoing workstreams - Establishes beta.grants.gov as the primary location that stakeholders can visit for project updates and previews of deliverables from each of the workstreams -- Proves the succesful completion of technical milestones that enable faster development without sacrificing code quality or security +- Proves the successful completion of technical milestones that enable faster development without sacrificing code quality or security - Delivers an early win that both internal and external stakeholders can rally around, which helps build momentum and enthusiam for the project ### User stories @@ -97,7 +97,7 @@ Process for drafting and updating the content of the site should balance: 1. Number of unique site visitors 2. Total number of site visits -3. Number of form responses +3. Stretch: Number of form responses 4. Uptime service 5. [Lighthouse score](lighthouse) for the site 6. Deployment build time From 8f8cd6ac6e0d30811ccbd122b1734aac043e5133 Mon Sep 17 00:00:00 2001 From: widal001 Date: Tue, 1 Aug 2023 10:28:01 -0400 Subject: [PATCH 09/13] fix(milestone): Incorporates PR feedback on Static Site Adds note about parallel development --- documentation/milestones/individual_milestones/static_site.md | 1 + 1 file changed, 1 insertion(+) diff --git a/documentation/milestones/individual_milestones/static_site.md b/documentation/milestones/individual_milestones/static_site.md index d9ed0fd79..ec073940c 100644 --- a/documentation/milestones/individual_milestones/static_site.md +++ b/documentation/milestones/individual_milestones/static_site.md @@ -27,6 +27,7 @@ By sharing this information in a publicly accessible format and investing early - Establishes beta.grants.gov as the primary location that stakeholders can visit for project updates and previews of deliverables from each of the workstreams - Proves the successful completion of technical milestones that enable faster development without sacrificing code quality or security - Delivers an early win that both internal and external stakeholders can rally around, which helps build momentum and enthusiam for the project +- Facilitates a parallel approach to development, in which new features can be built and tested on `beta.grants.gov` without risking or disrupting the existing functionality of legacy grants.gov ### User stories From b1620b74ecc0d590e7fc06575fd8f47edc035bc6 Mon Sep 17 00:00:00 2001 From: widal001 Date: Thu, 10 Aug 2023 13:46:24 -0400 Subject: [PATCH 10/13] fix(milestone): Incorporates feedback on Static Site doc - Adds DoD for publishing content to beta.grants.gov - Adds DoD for collecting web traffic data - Adds DoD for creating tickets to collect remaining metrics data - Adds outbound link data to metrics - Adds target release for FY24 Q1 for translation process --- .../individual_milestones/static_site.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/documentation/milestones/individual_milestones/static_site.md b/documentation/milestones/individual_milestones/static_site.md index ec073940c..2fdd2fbd6 100644 --- a/documentation/milestones/individual_milestones/static_site.md +++ b/documentation/milestones/individual_milestones/static_site.md @@ -84,7 +84,10 @@ Process for drafting and updating the content of the site should balance: - [ ] Anyone can access a live version of the site at beta.grants.gov - [ ] The site adopts the UI principles and framework established in the [Foundational UI milestone](https://github.com/HHS/grants-equity/issues/60) - [ ] The site is 508 compliant and satisfies the other guidelines outlined in the Accessibility Planning milestone + - [ ] Web traffic data for the site is actively being collected by the framework implemented in the [Web Analytics milestone](https://github.com/HHS/grants-equity/issues/63) + - [ ] Additional development tickets have been created for collecting other data needed to calculate the metrics below - [ ] The following content requirements are satisfied: + - [ ] All content is deployed to beta.grants.gov - [ ] The site contains information about both the NOFO Transformation and Grants.gov Modernization workstreams - [ ] The content on the site has been been reviewed and approved by the relevant stakeholders within each workstream - [ ] The site also links to external resources related to the project (if they are available), including: @@ -98,11 +101,16 @@ Process for drafting and updating the content of the site should balance: 1. Number of unique site visitors 2. Total number of site visits -3. Stretch: Number of form responses 4. Uptime service 5. [Lighthouse score](lighthouse) for the site 6. Deployment build time 7. Deployment/hosting costs +8. Number of PDF downloads per NOFO prototype +9. Number of outbound links to the following external resources (once added to the site) + - Open source repository + - Open source wiki + - Open source chat +10. Stretch: Number of form responses ### Destination for live updating metrics @@ -139,7 +147,7 @@ Page on the public wiki. **Note:** This will likely change once we deliver [the *The following work will* not *be completed as part of this milestone:* -1. **Translating site contents:** Translation of key documents will be covered in an upcoming milestone +1. **Translating site contents:** Translation of key documents will be covered in an upcoming milestone slotted for FY24 Q1 (Oct - Dec 2023) 2. **Legacy web analytics:** Updating the existing analytics recorded on legacy grants.gov in order to establish a baseline for comparing the site traffic for `beta.grants.gov` will happen in a later milestone ## Integrations @@ -153,7 +161,7 @@ Yes, the site contents will need to be translated. *If so, when will English-language content be locked? Then when will translation be started and completed?* -Timeline and strategy for translation is still TBD. +The initial process for translation is slotted for release sometime in FY24 Q1 (Oct - Dec 2023). ### Services going into PROD for the first time @@ -179,7 +187,7 @@ Timeline and strategy for translation is still TBD. *Are there any fields being shared publicly that have never been shared in PROD before?* -- No, the content of the static site in this milestone will be limited to informational about the project or about the NOFO prototypes that have already been published on legacy grants.gov. It does not include exposing any production data from the new NOFO data model. +- No, the content of the static site in this milestone will be limited to information about the project or about the NOFO prototypes that have already been published on legacy grants.gov. It does not include exposing any production data from the new Grants.gov data model. ### Security considerations From 1865300f0424dd4b50533e8b032f02bb6795a4fd Mon Sep 17 00:00:00 2001 From: Billy Daly Date: Mon, 14 Aug 2023 12:40:10 -0400 Subject: [PATCH 11/13] fix: Updates PDF views metric --- documentation/milestones/individual_milestones/static_site.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/milestones/individual_milestones/static_site.md b/documentation/milestones/individual_milestones/static_site.md index 2fdd2fbd6..886ba77ee 100644 --- a/documentation/milestones/individual_milestones/static_site.md +++ b/documentation/milestones/individual_milestones/static_site.md @@ -105,7 +105,7 @@ Process for drafting and updating the content of the site should balance: 5. [Lighthouse score](lighthouse) for the site 6. Deployment build time 7. Deployment/hosting costs -8. Number of PDF downloads per NOFO prototype +8. Number of PDF views per NOFO prototype 9. Number of outbound links to the following external resources (once added to the site) - Open source repository - Open source wiki From d4f25b33e83682cf665000d30063fc64873adc81 Mon Sep 17 00:00:00 2001 From: Billy Daly Date: Mon, 14 Aug 2023 12:41:28 -0400 Subject: [PATCH 12/13] fix: Updates outbound links metric --- documentation/milestones/individual_milestones/static_site.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/milestones/individual_milestones/static_site.md b/documentation/milestones/individual_milestones/static_site.md index 886ba77ee..a4d90f5dd 100644 --- a/documentation/milestones/individual_milestones/static_site.md +++ b/documentation/milestones/individual_milestones/static_site.md @@ -106,7 +106,7 @@ Process for drafting and updating the content of the site should balance: 6. Deployment build time 7. Deployment/hosting costs 8. Number of PDF views per NOFO prototype -9. Number of outbound links to the following external resources (once added to the site) +9. Number of visits to outbound links to the following external resources (once added to the site) - Open source repository - Open source wiki - Open source chat From 1e4efd6451956e341625f1f4317c36ac2852b36e Mon Sep 17 00:00:00 2001 From: widal001 Date: Tue, 15 Aug 2023 12:57:49 -0400 Subject: [PATCH 13/13] fix(milestone): Incorporate PR feedback in static site pt 2 - Links dependency GitHub issues - Adjust language around security approval --- .../individual_milestones/static_site.md | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/documentation/milestones/individual_milestones/static_site.md b/documentation/milestones/individual_milestones/static_site.md index a4d90f5dd..a537d1bb1 100644 --- a/documentation/milestones/individual_milestones/static_site.md +++ b/documentation/milestones/individual_milestones/static_site.md @@ -121,18 +121,18 @@ Page on the public wiki. **Note:** This will likely change once we deliver [the ### Assumptions & dependencies -*What capabilities / milestones do we expect to be in place at the beginning of work on this milestone?* +*What capabilities / milestones do we expect to be in place by the completion of work on this milestone?* -- [ ] **Front-end Planning:** Determines the language, framework, and deployment service used to build and host the site. -- [ ] **Developer Tools:** Establishes a suite of tools used to ensure the quality and security of the site codebase. -- [ ] **beta.grants.gov Domain:** Secures access to the `beta.grants.gov` domain which is where the site will be hosted. -- [ ] **Authority to Operate (ATO):** Ensures that the site and the infrastructure that hosts it are comply with the Software Security Plan for the legacy grants.gov site. -- [ ] **Infrastructure-as-Code:** Programmatically provisions the resources needed to deploy and host this site. -- [ ] **Front-end CI/CD:** Sets up a CI/CD pipeline that will be used to test and publish code changes to the site. -- [ ] **Foundational UI:** Determines the UI framework that the site will adopt before launch. -- [ ] **Web Analytics:** Enables tracking key success metrics for this milestone, e.g. site traffic and number of unique visitors. +- [ ] **[Front-end Planning](https://github.com/HHS/grants-equity/issues/49):** Determines the language, framework, and deployment service used to build and host the site. +- [ ] **[Developer Tools](https://github.com/HHS/grants-equity/issues/50):** Establishes a suite of tools used to ensure the quality and security of the site codebase. +- [ ] **[beta.grants.gov Domain](https://github.com/HHS/grants-equity/issues/51):** Secures access to the `beta.grants.gov` domain which is where the site will be hosted. +- [ ] **[Security Approval](https://github.com/HHS/grants-equity/issues/53):** Ensures that the site and the infrastructure that hosts it are comply with HHS security standards and practices. +- [ ] **[Infrastructure-as-Code](https://github.com/HHS/grants-equity/issues/123):** Programmatically provisions the resources needed to deploy and host this site. +- [ ] **[Front-end CI/CD](https://github.com/orgs/HHS/projects/12/views/3?pane=issue&itemId=31950276):** Sets up a CI/CD pipeline that will be used to test and publish code changes to the site. +- [ ] **[Foundational UI](https://github.com/HHS/grants-equity/issues/60):** Determines the UI framework that the site will adopt before launch. +- [ ] **[Web Analytics](https://github.com/HHS/grants-equity/issues/63):** Enables tracking key success metrics for this milestone, e.g. site traffic and number of unique visitors. -*Are there any notable capabilities / milestones do NOT we expect to be in place at the beginning of work on this milestone?* +*Are there any notable capabilities / milestones do NOT we expect to be in place by the completion of work on this milestone?* - [x] **Internationalization:** While there will be content delivered within this milestone that needs to be translated in the future, we do not expect to have a framework for managing translations set up by the time this milestone is delivered. - [x] **CMS:** While in the long-term we may want to support a Content Management Service (CMS) that allows non-technical users to update and manage copy for the website, we do not expect a CMS to be selected and implemented when we launch this site. @@ -199,7 +199,7 @@ The initial process for translation is slotted for release sometime in FY24 Q1 ( *If so, how are we addressing these risks?* -- **Authority to Operate (ATO):** Before the official launch of the static site to the public, we will be reviewing our infrastructure and code security practices with the HHS team to ensure that they adhere to the Software Security Plan (SSP) for legacy grants.gov and are covered by the existing ATO. +- **Security Approval:** Before the official launch of the static site to the public, we will be reviewing our infrastructure and code security practices with the HHS team to ensure that they adhere to HHS standards. - **Developer Tools:** As part of the Developer Tools milestone, the team is setting up a series of tools that will enforce certain code quality standards and security checks. These include things like secrets management, code linting, dependency monitoring, etc. - **Form Submissions:** The implementation plan for form submissions will evaluate and consider common security practices for validating and sanitizing user input. Form submissions will also likely be stored in a system that is separate from the production database with grant data.