Skip to content

Commit

Permalink
[Issue 819] Remove old language from docs (#934)
Browse files Browse the repository at this point in the history
Fix references to old repo name and outdated language.
  • Loading branch information
widal001 authored Dec 19, 2023
1 parent 2658ef1 commit e532534
Show file tree
Hide file tree
Showing 7 changed files with 49 additions and 49 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Pull requests should follow the conventions in [DEVELOPMENT.md](./DEVELOPMENT.md

### Open Source Policy

We adhere to the [HHS Open Source Policy](https://github.com/CMSGov/cms-open-source-policy). If you have any questions, just [shoot us an email](mailto:equityingrants@hhs.gov?subject=Question About Open Source Policy).
We adhere to the [HHS Open Source Policy](https://github.com/CMSGov/cms-open-source-policy). If you have any questions, just [shoot us an email](mailto:simpler@grants.gov?subject=Question About Open Source Policy).

### Security and Responsible Disclosure Policy

Expand Down
2 changes: 1 addition & 1 deletion documentation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This folder contains documentation for the Simpler Grants Project.

Our vision is for the following to become true:

**_Grants.gov is the simplest, most inclusive, and most gratifying way to find and apply for financial assistance ever built, inside or outside the federal government. Grants.gov helps ensure that no communities are underserved by the federal government_**.
**_We want Grants.gov to be an extremely simple, accessible, and easy-to-use tool for posting, finding, sharing, and applying for federal financial assistance. Our mission is to increase access to grants and improve the grants experience for everyone._**.

See [goals.md](./goals.md) for more information about the vision and goals for the project.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ DAP cannot be used for authenticated pages. We recommend Google Analytics with a

### Positive Consequences <!-- OPTIONAL -->

- **Data-Driven Decision Making**: With an analytics platform, our project can gather valuable data and insights about usage and identify where there are shortfalls to our product. It can allow us to ensure we are building an equitable solution for the public. This data-driven approach enables informed decision-making and allows teams to identify trends, opportunities, and areas for improvement.
- **Data-Driven Decision Making**: With an analytics platform, our project can gather valuable data and insights about usage and identify where there are shortfalls to our product. It can allow us to ensure we are building an accessible solution for the public. This data-driven approach enables informed decision-making and allows teams to identify trends, opportunities, and areas for improvement.
- **Improved Performance**: Analytics platforms help track key performance indicators (KPIs) and measure the success of various initiatives and deliverables. By monitoring these metrics, we can optimize our strategies and improve overall performance.
- **Enhanced User Experience**: Understanding user behavior through analytics helps tailor products, services, and content to meet users' needs and preferences leading to a better user experience.

Expand Down
30 changes: 15 additions & 15 deletions documentation/decisions/adr/2023-10-16-email-marketing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

- **Status:** Active
- **Last Modified:** 2023-12-04 <!-- REQUIRED -->
- **Related Issue:** [#590](https://github.com/HHS/grants-equity/issues/590) <!-- RECOMMENDED -->
- **Related Issue:** [#590](https://github.com/HHS/simpler-grants-gov/issues/590) <!-- RECOMMENDED -->
- **Deciders:** Lucas Brown, Aaron Couch, Billy Daly, Sarah Knopp, Sumi Thaiveettil
- **Tags:** communucations, open source, email marketing

## Context and Problem Statement

An email marketing tool is primarily used for creating, sending, and tracking email campaigns to a list of subscribers. It allows for us to engage with our audience, push notifications and newsletters to our users, share information, and build customer relationships through email.
An email marketing tool is primarily used for creating, sending, and tracking email campaigns to a list of subscribers. It allows for us to engage with our audience, push notifications and newsletters to our users, share information, and build customer relationships through email.

## Decision Drivers <!-- RECOMMENDED -->

Expand All @@ -21,7 +21,7 @@ An email marketing tool is primarily used for creating, sending, and tracking em
- **Analytics:** The platform should provide support for tracking open rates, click-through-rate and other other web analytics.
- **Onboarding Costs:** Onboarding new members to the platform should be relatively inexpensive, both in terms of staff time/resources and direct costs (e.g. licensing fees).
- **Maintenance Costs:** It should not be prohibitively expensive to maintain the email marketing tool, both in terms of staff time/resources and direct costs (e.g. hosting fees).
- **Authority to Operate (ATO):** The tool should be FedRAMPed or have an Authority to Operate as it will have names and email addresses of public users.
- **Authority to Operate (ATO):** The tool should be FedRAMPed or have an Authority to Operate as it will have names and email addresses of public users.

#### Nice to Have

Expand All @@ -32,41 +32,41 @@ An email marketing tool is primarily used for creating, sending, and tracking em
## Options Considered


- [Sendy](https://sendy.co/)
- [Salesforce Marketing](https://www.salesforce.com/products/engagement-marketing/)
- [Sendy](https://sendy.co/)
- [Salesforce Marketing](https://www.salesforce.com/products/engagement-marketing/)
- [MailChimp](https://mailchimp.com/)
- [Hubspot](https://www.hubspot.com/)
- [Mautic](https://www.mautic.org/)
- [Adobe Campaign](https://business.adobe.com/products/campaign/adobe-campaign.html)

## Decision Outcome <!-- REQUIRED -->

The suggested approach is to utilize Sendy and create a campaign for Simpler Grants.gov within the existing main account for the near-term, leveraging existing knowledge and allowing for faster use. This allows for a faster initiation of the process. One of the most important criteria given by users of the tool, the Grants.gov Communications team, is the need to be able to send an email to the current 1M current subscribers quickly which Sendy cannot do. There are other limitations of this solution so we recommend that we select a back-up option email marketing solution for our long-term needs.
The suggested approach is to utilize Sendy and create a campaign for Simpler Grants.gov within the existing main account for the near-term, leveraging existing knowledge and allowing for faster use. This allows for a faster initiation of the process. One of the most important criteria given by users of the tool, the Grants.gov Communications team, is the need to be able to send an email to the current 1M current subscribers quickly which Sendy cannot do. There are other limitations of this solution so we recommend that we select a back-up option email marketing solution for our long-term needs.

There are limitations to Sendy and the recommendation is to move to another email marketing tool that is a better long-term solution that works for HHS and the larger communications strategy for Simpler Grants.gov, current Grants.gov, and NOFO. This makes it easier and consistent to implement and manage one tool.
There are limitations to Sendy and the recommendation is to move to another email marketing tool that is a better long-term solution that works for HHS and the larger communications strategy for Simpler Grants.gov, current Grants.gov, and NOFO. This makes it easier and consistent to implement and manage one tool.


### Open Questions <!-- OPTIONAL -->

1. Can we transfer the Simpler Grants.gov email list from Sendy to a different tool in the future?

Yes, we are able to transfer the list created in Sendy to a new tool in the future.
Yes, we are able to transfer the list created in Sendy to a new tool in the future.

2. What is the long-term tool that we should use?

As we're determining the brand identity and communications strategy and how the different HHS teams will work together, we will determine the long-term solution at a later time.
As we're determining the brand identity and communications strategy and how the different HHS teams will work together, we will determine the long-term solution at a later time.

3. Can we send to individual lists?

We can use Sendy to send to individuals and also for a separate subscription lists which is called a "Brand" in Sendy.

5. How can we integrate with the current implementation of Sendy?

A Brand can be created under the existing Sendy account which allows users who subscribe through that form to be added to a separate list specific to Simpler.Grants.gov. This list will be distinct from the other lists within the Sendy account.

6. For the long term solution, there are certain requirements and considerations that we should consider?
- Currently when users unsubscribe, a script needs to be run to remove them from the list. We should consider a system that automatically updates the system.
- The new platform should have an API that is robust enough to allow users to subscribe, unsubscribe, and check for existing users.
- The new platform should have an API that is robust enough to allow users to subscribe, unsubscribe, and check for existing users.



Expand Down Expand Up @@ -114,7 +114,7 @@ Sendy is a self-hosted email marketing application that allows users to send new

#### Cons

- Campaigns with larger audiences or number of emails take a long time to send and a user cannot use the tool while an email is being sent. Currently, we have 1M subscribers and it takes a long time to send to that many subscribers. There are methods that could be done to improve this.
- Campaigns with larger audiences or number of emails take a long time to send and a user cannot use the tool while an email is being sent. Currently, we have 1M subscribers and it takes a long time to send to that many subscribers. There are methods that could be done to improve this.
- Lacks some advanced features present in other platforms.
- It requires technical knowledge for setup and maintenance.
- Limited customer support compared to premium services.
Expand Down Expand Up @@ -222,8 +222,8 @@ Adobe Campaign is a marketing automation tool that forms part of the Adobe Exper

## Links <!-- OPTIONAL -->

- [Sendy](https://sendy.co/)
- [Salesforce Marketing](https://www.salesforce.com/products/engagement-marketing/)
- [Sendy](https://sendy.co/)
- [Salesforce Marketing](https://www.salesforce.com/products/engagement-marketing/)
- [MailChimp](https://mailchimp.com/)
- [Hubspot](https://www.hubspot.com/)
- [Mautic](https://www.mautic.org/)
Expand Down
40 changes: 20 additions & 20 deletions documentation/deliverables/individual_deliverables/search_mvp.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
| Field | Value |
| ------------------ | ---------------------------------------------------------- |
| Document Status | Completed |
| Deliverable ticket | [Issue 89](https://github.com/HHS/grants-equity/issues/89) |
| Deliverable ticket | [Issue 89](https://github.com/HHS/simpler-grants-gov/issues/89) |
| Roadmap dashboard | [Product roadmap](https://github.com/orgs/HHS/projects/12) |
| Product owner | Lucas Brown |
| Document owner | Billy Daly |
Expand Down Expand Up @@ -114,7 +114,7 @@ The primary page we'll need to deliver for the user interface (UI) is a search p
### Destination for live updating metrics
<!-- Required -->

Page on the public wiki. **Note:** This will likely change once we deliver the [Public Measurement Dashboard milestone](https://github.com/HHS/grants-equity/issues/65)
Page on the public wiki. **Note:** This will likely change once we deliver the [Public Measurement Dashboard milestone](https://github.com/HHS/simpler-grants-gov/issues/65)

## Planning

Expand All @@ -123,22 +123,22 @@ Page on the public wiki. **Note:** This will likely change once we deliver the [

What functionality do we expect to be in place ***before*** work starts on this deliverable?

- **Front-end:** The search UI will build on the front-end work completed in both the [initial static site launch](https://github.com/HHS/grants-equity/issues/62) and the [subsequent improvements](https://github.com/HHS/grants-equity/issues/568) that created the following functionality:
- **[Front-end CI/CD](https://github.com/HHS/grants-equity/issues/58):** Automatically tests and deploys front-end code
- **[Foundational UI](https://github.com/HHS/grants-equity/issues/60):** Enforces a consistent user interface and web design system across the frontend
- **[Translation Process](https://github.com/HHS/grants-equity/issues/81):** Facilitates and publishes translations of front-end content in multiple languages
- **API:** The search API will build on the existing backend work completed to launch the [GET Opportunities endpoint](https://github.com/HHS/grants-equity/issues/70) which delivered the following functionality:
- **[Backend CI/CD](https://github.com/HHS/grants-equity/issues/57):** Automatically tests and deploys backend code
- **[Database Replica](https://github.com/HHS/grants-equity/issues/54):** Maintains eventual consistency (with low latency) between the data in grants.gov and simpler.grants.gov and ensures that simpler.grants.gov services remain available when grants.gov services experience downtime
- **[Data Architecture](https://github.com/HHS/grants-equity/issues/125):** Enables simpler.grants.gov to read data from an updated (and simplified) data model
- **[API Docs](https://github.com/HHS/grants-equity/issues/71):** Documents the API endpoints released with each deliverable
- **Front-end:** The search UI will build on the front-end work completed in both the [initial static site launch](https://github.com/HHS/simpler-grants-gov/issues/62) and the [subsequent improvements](https://github.com/HHS/simpler-grants-gov/issues/568) that created the following functionality:
- **[Front-end CI/CD](https://github.com/HHS/simpler-grants-gov/issues/58):** Automatically tests and deploys front-end code
- **[Foundational UI](https://github.com/HHS/simpler-grants-gov/issues/60):** Enforces a consistent user interface and web design system across the frontend
- **[Translation Process](https://github.com/HHS/simpler-grants-gov/issues/81):** Facilitates and publishes translations of front-end content in multiple languages
- **API:** The search API will build on the existing backend work completed to launch the [GET Opportunities endpoint](https://github.com/HHS/simpler-grants-gov/issues/70) which delivered the following functionality:
- **[Backend CI/CD](https://github.com/HHS/simpler-grants-gov/issues/57):** Automatically tests and deploys backend code
- **[Database Replica](https://github.com/HHS/simpler-grants-gov/issues/54):** Maintains eventual consistency (with low latency) between the data in grants.gov and simpler.grants.gov and ensures that simpler.grants.gov services remain available when grants.gov services experience downtime
- **[Data Architecture](https://github.com/HHS/simpler-grants-gov/issues/125):** Enables simpler.grants.gov to read data from an updated (and simplified) data model
- **[API Docs](https://github.com/HHS/simpler-grants-gov/issues/71):** Documents the API endpoints released with each deliverable

What functionality do we expect to be in place by ***the end*** of work on this deliverable?

- **[Incident Response](https://github.com/HHS/grants-equity/issues/373):** Ensures that we have a robust incident response plan in place when simpler.grants.gov services are interrupted
- **[Search API](https://github.com/HHS/grants-equity/issues/90):** Enables system-to-system users to access the search features through the API
- **[Search Page](https://github.com/HHS/grants-equity/issues/576):** Enables all other users to access the search features through the user interface
- **[User Research Incentives](https://github.com/HHS/grants-equity/issues/84):** Enables us to engage stakeholders for user testing of the new search functionality
- **[Incident Response](https://github.com/HHS/simpler-grants-gov/issues/373):** Ensures that we have a robust incident response plan in place when simpler.grants.gov services are interrupted
- **[Search API](https://github.com/HHS/simpler-grants-gov/issues/90):** Enables system-to-system users to access the search features through the API
- **[Search Page](https://github.com/HHS/simpler-grants-gov/issues/576):** Enables all other users to access the search features through the user interface
- **[User Research Incentives](https://github.com/HHS/simpler-grants-gov/issues/84):** Enables us to engage stakeholders for user testing of the new search functionality

Is there any notable functionality we do ***not*** expect to be in place before works starts on this deliverable?

Expand All @@ -150,11 +150,11 @@ Is there any notable functionality we do ***not*** expect to be in place before

#### Does the metadata and the text of the opportunity need to be translated?

We will determine if individual fields from the search results can be easily translated in this effort but opportunity listings and all search results will _**not**_ be translated in this 30k ft deliverable.
We will determine if individual fields from the search results can be easily translated in this effort but opportunity listings and all search results will _**not**_ be translated in this 30k ft deliverable.

#### What metadata is currently available about each opportunity?

Metadata is being determined in the [GET Opportunity 30k deliverable](https://github.com/HHS/simpler-grants-gov/issues/70). We plan to use publicly available data only. For example, `is_draft` state will not be used in this Search feature.
Metadata is being determined in the [GET Opportunity 30k deliverable](https://github.com/HHS/simpler-grants-gov/issues/70). We plan to use publicly available data only. For example, `is_draft` state will not be used in this Search feature.

### Not doing
<!-- Optional -->
Expand Down Expand Up @@ -198,15 +198,15 @@ Are there multiple services that are being connected for the first time in PROD?

_Are there any fields being shared publicly that have never been shared in PROD before?_

The search data and text will be shared for the first time on the site.
The search data and text will be shared for the first time on the site.

### Security considerations
<!-- Required -->

_Does this 30k ft deliverable expose any new attack vectors or expand the attack surface of the product?_

We're exposing new endpoints that are all read-only this limits vulnerabilities.
We're exposing new endpoints that are all read-only this limits vulnerabilities.

_If so, how are we addressing these risks?_

We plan to complete a security review and set up any mitigation strategies as needed.
We plan to complete a security review and set up any mitigation strategies as needed.
Loading

0 comments on commit e532534

Please sign in to comment.