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

Documentation Request: Environment Configuration Guidelines #103

Open
CFIALeronB opened this issue Jan 23, 2024 · 0 comments · May be fixed by #104
Open

Documentation Request: Environment Configuration Guidelines #103

CFIALeronB opened this issue Jan 23, 2024 · 0 comments · May be fixed by #104
Assignees
Labels
good first issue Good for newcomers

Comments

@CFIALeronB
Copy link
Contributor

Issue Description

We currently have multiple environment configuration files (environment.ts, environment.staging.ts, and environment.prod.ts) to manage our application settings across different deployment stages. However, it seems that there's no centralized documentation describing the usage, purpose, and selection process of these environment files. This can lead to confusion and inconsistency across the team, especially for new members.

Suggested Documentation Additions

To address this, I propose we add a new section to our existing documentation (or README.md) covering the following points:

  1. Overview of Environment Files:

    • Briefly describe the purpose of each environment file (environment.ts, environment.staging.ts, environment.prod.ts).
  2. Environment Selection Process:

    • Explain how the application determines which environment file to use, primarily focusing on the NODE_ENV environment variable.
  3. Key Features and Benefits:

    • Highlight the benefits of having separate environment files, such as tailored configurations for different deployment stages and consistency across projects.
  4. Basic Usage Guidelines:

    • Provide a general guide on how to use these environment files within the project, without going into too much detail or specific code examples.
@CFIALeronB CFIALeronB self-assigned this Jan 23, 2024
CFIALeronB added a commit that referenced this issue Jan 23, 2024
- Updated README.md to include guidelines on using and understanding environment configuration files (environment.ts, environment.staging.ts, environment.prod.ts). The documentation covers file purposes, environment selection process, key features, and basic usage guidelines.

#103
@CFIALeronB CFIALeronB linked a pull request Jan 23, 2024 that will close this issue
@CFIALeronB CFIALeronB linked a pull request Jan 23, 2024 that will close this issue
@SonOfLope SonOfLope added the good first issue Good for newcomers label Feb 23, 2024
@SonOfLope SonOfLope moved this to Todo in DevSecOps Feb 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
Status: Todo
Development

Successfully merging a pull request may close this issue.

2 participants