mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-08-25 00:33:58 -04:00
Clean up typos
This changeset cleans up a variety of typos that were found and submitted in PR #2588; we cannot directly accept external contributions, but we appreciate the flagging of things like this! Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This commit is contained in:
@@ -31,7 +31,7 @@ You will need the following items:
|
|||||||
[setting up an account](https://cloud.gov/sign-up/) (requires a `.mil`,
|
[setting up an account](https://cloud.gov/sign-up/) (requires a `.mil`,
|
||||||
`.gov`, or `.fed.us` email address) and getting access to the
|
`.gov`, or `.fed.us` email address) and getting access to the
|
||||||
`notify-local-dev` and `notify-staging` spaces.
|
`notify-local-dev` and `notify-staging` spaces.
|
||||||
- Admin priviliges and SSH access on your machine; you may need to work with
|
- Admin privileges and SSH access on your machine; you may need to work with
|
||||||
your organization's IT support staff if you're not sure or don't currently
|
your organization's IT support staff if you're not sure or don't currently
|
||||||
have this access.
|
have this access.
|
||||||
|
|
||||||
|
|||||||
@@ -18,4 +18,4 @@ If you're working in VS Code, you can also leverage Docker for a containerized d
|
|||||||
|
|
||||||
1. Go to http://localhost:6012
|
1. Go to http://localhost:6012
|
||||||
|
|
||||||
NOTE: when you change .env in the future, you'll need to rebuild the devcontainer for the change to take effect. VS Code _should_ detect the change and prompt you with a toast notification during a cached build. If not, you can find a manual rebuild in command pallette or just `docker rm` the notifications-api container.
|
NOTE: when you change .env in the future, you'll need to rebuild the devcontainer for the change to take effect. VS Code _should_ detect the change and prompt you with a toast notification during a cached build. If not, you can find a manual rebuild in command palette or just `docker rm` the notifications-api container.
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
## Using Environment Variables
|
## Using Environment Variables
|
||||||
|
|
||||||
This guide explains how to update cloud foundry envirionment variables to enable or disable feature flagging.
|
This guide explains how to update cloud foundry environment variables to enable or disable feature flagging.
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
|
|||||||
@@ -50,7 +50,7 @@ Sprint velocity was very low due to holiday OOO
|
|||||||
| | Goals | Impact | Milestone(s) |
|
| | Goals | Impact | Milestone(s) |
|
||||||
|-------------|-----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|--------------|
|
|-------------|-----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|--------------|
|
||||||
| Engineering | Change timezones displays to [Eastern time](https://github.com/GSA/notifications-admin/issues/861), [create properties on org model](https://github.com/GSA/notifications-api/issues/331) to process agreement info | Better timezone familiarity, continuity between application orgs and agreements | Building Notify.gov |
|
| Engineering | Change timezones displays to [Eastern time](https://github.com/GSA/notifications-admin/issues/861), [create properties on org model](https://github.com/GSA/notifications-api/issues/331) to process agreement info | Better timezone familiarity, continuity between application orgs and agreements | Building Notify.gov |
|
||||||
| UX | Begin [re-thinking Notify IA](https://github.com/GSA/notifications-admin/issues/910), create a synthesis of partner feeback thusfar, wireframe a more [user-friendly dashboard](https://github.com/GSA/notifications-admin/issues/889), send [Notify logo](https://github.com/GSA/notifications-admin/issues/859) proposal to begin approvals, add UI consideration regarding [multi-lingual messages](https://github.com/GSA/notifications-admin/issues/901) | Improve ease of use, begin process of brand creation | Obtain approval for logo/brand|
|
| UX | Begin [re-thinking Notify IA](https://github.com/GSA/notifications-admin/issues/910), create a synthesis of partner feedback thusfar, wireframe a more [user-friendly dashboard](https://github.com/GSA/notifications-admin/issues/889), send [Notify logo](https://github.com/GSA/notifications-admin/issues/859) proposal to begin approvals, add UI consideration regarding [multi-lingual messages](https://github.com/GSA/notifications-admin/issues/901) | Improve ease of use, begin process of brand creation | Obtain approval for logo/brand|
|
||||||
| Security | Complete pre-requisite documentation, start project planning timelines and control group deadlines | Aim to have package completed with enough time to allow for long assessment| Secure ATO |
|
| Security | Complete pre-requisite documentation, start project planning timelines and control group deadlines | Aim to have package completed with enough time to allow for long assessment| Secure ATO |
|
||||||
| Content | Finalize cloud.gov pages IAA mod for content site | Enable an easy static website for future content | Building Notify.gov |
|
| Content | Finalize cloud.gov pages IAA mod for content site | Enable an easy static website for future content | Building Notify.gov |
|
||||||
| Ops | Complete Beverly's onboarding with necessary access to cloud.gov, AWS, and other tools| Add valuable dev resources to increase our capacity
|
| Ops | Complete Beverly's onboarding with necessary access to cloud.gov, AWS, and other tools| Add valuable dev resources to increase our capacity
|
||||||
@@ -59,7 +59,7 @@ Sprint velocity was very low due to holiday OOO
|
|||||||
|
|
||||||
| | Goals | Impact |
|
| | Goals | Impact |
|
||||||
|-------------|-----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
|
|-------------|-----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| Engineering | Continue login.gov [sandbox implementation](https://github.com/GSA/notifications-admin/issues/338), catch up deploys that lag from last week's dependency audit failures, change timezones displays to [Eastern time](https://github.com/GSA/notifications-admin/issues/861), Persist [individal send reports](https://github.com/GSA/notifications-admin/issues/855) somwehere in the app| Stronger auth security, streamlined UX, better timezone familiarity |
|
| Engineering | Continue login.gov [sandbox implementation](https://github.com/GSA/notifications-admin/issues/338), catch up deploys that lag from last week's dependency audit failures, change timezones displays to [Eastern time](https://github.com/GSA/notifications-admin/issues/861), Persist [individual send reports](https://github.com/GSA/notifications-admin/issues/855) somwehere in the app| Stronger auth security, streamlined UX, better timezone familiarity |
|
||||||
| UX | Continue making common-sense [UI/UX changes](https://github.com/GSA/notifications-admin/issues/828), review and finalize proposal for [Notify logo](https://github.com/GSA/notifications-admin/issues/859) & begin approvals chain | Improve ease of use, begin process of brand creation |
|
| UX | Continue making common-sense [UI/UX changes](https://github.com/GSA/notifications-admin/issues/828), review and finalize proposal for [Notify logo](https://github.com/GSA/notifications-admin/issues/859) & begin approvals chain | Improve ease of use, begin process of brand creation |
|
||||||
| Security | Complete pre-requisite documentation, start project planning timelines and control group deadlines | Aim to have package completed with enough time to allow for long assessment|
|
| Security | Complete pre-requisite documentation, start project planning timelines and control group deadlines | Aim to have package completed with enough time to allow for long assessment|
|
||||||
| Content | Finalize cloud.gov pages IAA mod for content site | Enable an easy static website for future content |
|
| Content | Finalize cloud.gov pages IAA mod for content site | Enable an easy static website for future content |
|
||||||
@@ -117,7 +117,7 @@ Sprint velocity was very low due to holiday OOO
|
|||||||
| | Goals | Impact |
|
| | Goals | Impact |
|
||||||
|-------------|-----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
|
|-------------|-----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| Engineering | (Due to low engineering availability, the goals from last sprint continue) Reduce [technical debt](https://github.com/GSA/notifications-api/issues/361) and stabilize application; carry out rigorous [testing](https://github.com/GSA/notifications-api/issues/312) of features and [infrastructure](https://github.com/GSA/notifications-api/issues/87); solve known [bugs](https://github.com/GSA/notifications-api/issues/360) | Increase app reliability prior to first partner use |
|
| Engineering | (Due to low engineering availability, the goals from last sprint continue) Reduce [technical debt](https://github.com/GSA/notifications-api/issues/361) and stabilize application; carry out rigorous [testing](https://github.com/GSA/notifications-api/issues/312) of features and [infrastructure](https://github.com/GSA/notifications-api/issues/87); solve known [bugs](https://github.com/GSA/notifications-api/issues/360) | Increase app reliability prior to first partner use |
|
||||||
| UX | Analyze data gathered from user-testing and propose changes from that analyzation; Hone a visual brand strategy for proposal to leadership | Improve upon oft-identified user barriers; create a consisten look and feel for Notify.gov |
|
| UX | Analyze data gathered from user-testing and propose changes from that analyzation; Hone a visual brand strategy for proposal to leadership | Improve upon oft-identified user barriers; create a consistent look and feel for Notify.gov |
|
||||||
| Security | Respond to any assessment questions and/or needs (assessment is nearing end) | Keep the LATO award timeline as short as possible|
|
| Security | Respond to any assessment questions and/or needs (assessment is nearing end) | Keep the LATO award timeline as short as possible|
|
||||||
| Content | Collate research to inform future best practices content | Have content ready for later addition to the site
|
| Content | Collate research to inform future best practices content | Have content ready for later addition to the site
|
||||||
|
|
||||||
|
|||||||
@@ -103,7 +103,7 @@ class RedisClient:
|
|||||||
|
|
||||||
Notes:
|
Notes:
|
||||||
- Failed requests count. If over the limit and keep making requests you'll stay over the limit.
|
- Failed requests count. If over the limit and keep making requests you'll stay over the limit.
|
||||||
- The actual value in the set is just the timestamp, the same as the score. We don't store any requets details.
|
- The actual value in the set is just the timestamp, the same as the score. We don't store any request details.
|
||||||
- return value of pipe.execute() is an array containing the outcome of each call.
|
- return value of pipe.execute() is an array containing the outcome of each call.
|
||||||
- result[2] == outcome of pipe.zcard()
|
- result[2] == outcome of pipe.zcard()
|
||||||
- If redis is inactive, or we get an exception, allow the request
|
- If redis is inactive, or we get an exception, allow the request
|
||||||
|
|||||||
@@ -338,7 +338,7 @@ def strip_and_remove_obscure_whitespace(value):
|
|||||||
|
|
||||||
|
|
||||||
def remove_whitespace(value):
|
def remove_whitespace(value):
|
||||||
# Removes ALL whitespace, not just the obscure characters we normaly remove
|
# Removes ALL whitespace, not just the obscure characters we normally remove
|
||||||
for character in ALL_WHITESPACE:
|
for character in ALL_WHITESPACE:
|
||||||
value = value.replace(character, "")
|
value = value.replace(character, "")
|
||||||
|
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ from ordered_set import OrderedSet
|
|||||||
class InsensitiveDict(dict):
|
class InsensitiveDict(dict):
|
||||||
"""
|
"""
|
||||||
`InsensitiveDict` behaves like an ordered dictionary, except it normalises
|
`InsensitiveDict` behaves like an ordered dictionary, except it normalises
|
||||||
case, whitespace, hypens and underscores in keys.
|
case, whitespace, hyphens and underscores in keys.
|
||||||
|
|
||||||
In other words,
|
In other words,
|
||||||
InsensitiveDict({'FIRST_NAME': 'example'}) == InsensitiveDict({'first name': 'example'})
|
InsensitiveDict({'FIRST_NAME': 'example'}) == InsensitiveDict({'first name': 'example'})
|
||||||
@@ -23,7 +23,7 @@ class InsensitiveDict(dict):
|
|||||||
def from_keys(cls, keys):
|
def from_keys(cls, keys):
|
||||||
"""
|
"""
|
||||||
This behaves like `dict.from_keys`, except:
|
This behaves like `dict.from_keys`, except:
|
||||||
- it normalises the keys to ignore case, whitespace, hypens and
|
- it normalises the keys to ignore case, whitespace, hyphens and
|
||||||
underscores
|
underscores
|
||||||
- it stores the original, unnormalised key as the value of the
|
- it stores the original, unnormalised key as the value of the
|
||||||
item so it can be retrieved later
|
item so it can be retrieved later
|
||||||
|
|||||||
@@ -510,7 +510,7 @@
|
|||||||
'66':
|
'66':
|
||||||
attributes:
|
attributes:
|
||||||
alpha: REG
|
alpha: REG
|
||||||
comment: Maximum long message lenght is 459 for GSM7 or 201 for Unicode alphabet.
|
comment: Maximum long message length is 459 for GSM7 or 201 for Unicode alphabet.
|
||||||
Special registration procedure for sending to DND numbers
|
Special registration procedure for sending to DND numbers
|
||||||
dlr: 'YES'
|
dlr: 'YES'
|
||||||
generic_sender: SMS
|
generic_sender: SMS
|
||||||
@@ -577,7 +577,7 @@
|
|||||||
sender_and_registration_info: All senders CONVERTED into one available national
|
sender_and_registration_info: All senders CONVERTED into one available national
|
||||||
numeric sender
|
numeric sender
|
||||||
text_restrictions: Content template MUST be approved by the MNO. Transactional
|
text_restrictions: Content template MUST be approved by the MNO. Transactional
|
||||||
traffic ONLY. Sufix added in the message text
|
traffic ONLY. Suffix added in the message text
|
||||||
billable_units: 1
|
billable_units: 1
|
||||||
names:
|
names:
|
||||||
- China
|
- China
|
||||||
|
|||||||
@@ -652,7 +652,7 @@ def _do_simple_email_checks(match, email_address):
|
|||||||
def validate_email_address(email_address): # noqa (C901 too complex)
|
def validate_email_address(email_address): # noqa (C901 too complex)
|
||||||
# almost exactly the same as by https://github.com/wtforms/wtforms/blob/master/wtforms/validators.py,
|
# almost exactly the same as by https://github.com/wtforms/wtforms/blob/master/wtforms/validators.py,
|
||||||
# with minor tweaks for SES compatibility - to avoid complications we are a lot stricter with the local part
|
# with minor tweaks for SES compatibility - to avoid complications we are a lot stricter with the local part
|
||||||
# than neccessary - we don't allow any double quotes or semicolons to prevent SES Technical Failures
|
# than necessary - we don't allow any double quotes or semicolons to prevent SES Technical Failures
|
||||||
email_address = strip_and_remove_obscure_whitespace(email_address)
|
email_address = strip_and_remove_obscure_whitespace(email_address)
|
||||||
match = re.match(EMAIL_REGEX_PATTERN, email_address)
|
match = re.match(EMAIL_REGEX_PATTERN, email_address)
|
||||||
|
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ class SerialisedModel(ABC):
|
|||||||
guarantees that:
|
guarantees that:
|
||||||
- all of the ALLOWED_PROPERTIES are present in the underlying
|
- all of the ALLOWED_PROPERTIES are present in the underlying
|
||||||
dictionary
|
dictionary
|
||||||
- any other abritrary properties of the underlying dictionary can’t
|
- any other arbitrary properties of the underlying dictionary can’t
|
||||||
be accessed
|
be accessed
|
||||||
|
|
||||||
If you are adding a new field to a model, you should ensure that
|
If you are adding a new field to a model, you should ensure that
|
||||||
|
|||||||
@@ -207,7 +207,7 @@ class BaseSMSTemplate(Template):
|
|||||||
# subclass, to avoid any HTML formatting. SMS templates differ
|
# subclass, to avoid any HTML formatting. SMS templates differ
|
||||||
# in that the content can include the service name as a prefix.
|
# in that the content can include the service name as a prefix.
|
||||||
# So historically we’ve returned the fully-formatted message,
|
# So historically we’ve returned the fully-formatted message,
|
||||||
# rather than some plain-text represenation of the content. To
|
# rather than some plain-text representation of the content. To
|
||||||
# preserve compatibility for consumers of the API we maintain
|
# preserve compatibility for consumers of the API we maintain
|
||||||
# that behaviour by overriding this method here.
|
# that behaviour by overriding this method here.
|
||||||
return SMSMessageTemplate.__str__(self)
|
return SMSMessageTemplate.__str__(self)
|
||||||
|
|||||||
Reference in New Issue
Block a user