Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Miscellaneous minor updates #847

Merged
merged 2 commits into from
Jan 23, 2025
Merged

docs: Miscellaneous minor updates #847

merged 2 commits into from
Jan 23, 2025

Conversation

doshitan
Copy link
Contributor

Changes

  • More app -> <APP_NAME> placeholder updates
  • Fix the casing of some proper nouns
  • Clarify you don't set the AWS account name in the application environment
    configuration anymore, but in the network[1]
  • Misc. spelling mistakes/typos

[1] https://github.com/navapbc/template-infra/releases/tag/v0.11.0

Testing

Look at it.

@@ -14,7 +14,7 @@ Before setting up the application's environments you'll need to have:
1. Make sure you update `has_database` to `true` or `false` (defaults to `true`) depending on whether or not your application has a database to integrate with.
2. Make sure you update `has_external_non_aws_service` to `true` or `false` depending on whether your application utilizes any non-AWS services. Other applications within the same git repo count as external services, so if your application makes API calls to another application service in the same git repo, set `has_external_non_aws_service` to `true`.
3. If you're configuring your production environment, make sure to update the `service_cpu`, `service_memory`, and `service_desired_instance_count` settings based on the project's needs. If your application is sensitive to performance, consider doing a load test.
4. Make sure your application environment is using the AWS Account you want to use by checking the `account_name` property in the environment configuration and updating it if necessary.
4. Make sure your application environment is using the network/AWS Account you want to use by checking the `network_name` property in the environment configuration and what account it maps to in the project configuration. Update the values if necessary.
Copy link
Contributor Author

@doshitan doshitan Jan 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lorenyu not sure what exactly was the goal with original messaging. Should we orient folks to the network or the account (after v0.11.0)?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm. I guess both makes sense. This update makes sense to me

@doshitan doshitan requested a review from lorenyu January 22, 2025 21:25
@doshitan doshitan merged commit 09d0ede into main Jan 23, 2025
9 checks passed
@doshitan doshitan deleted the doshitan/misc-docs branch January 23, 2025 14:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants