When contributing to the Analytical Platform user guidance, you should make sure that your changes follow the spelling and grammar conventions outlined below.
Upper case.
Upper case. Do not just use the term Athena.
Upper case. Do not just use the term S3.
Sentence case.
Use Analytical Platform at first mention. After that, use Analytical Platform or Platform, if it clear what you are referring to.
Do not use the acronym AP.
Use app to refer to all types of app on the Analytical Platform. Do not use the term webapp.
Use the following terms to refer to specific types of app:
- Dash app
- R Shiny app
- static web app
Lower case.
Lower case.
All caps.
Use Data Engineering when referring to the team. Use data engineering when referring to the discipline.
Upper case.
All caps. No spaces or hyphens.
Enclose the names of files in single backticks so they are displayed as inline code. For example `environment.yml`, would be displayed as environment.yml.
Upper case. Do not use the terms Github or github.
Upper case.
Upper case. No space or hyphen.
Upper case.
Enclose the names of package names in single backticks so they are displayed as inline code. For example `pandas`, would be displayed as pandas.
Lower case.
Upper case.
Upper case.
Lower case.
Do not use the term repo.
Enclose the names of GitHub repositories in single backticks so they are displayed as inline code. For example `user-guidance`, would be displayed as user-guidance.
Upper case.
Upper case. No space or hyphen.
Upper case.
Lower case.
Use two-factor authentication (2FA) at first mention. After that, use 2FA.