fontebasso / fontebasso/envguardr

Add usage examples

Open
#39 0 comments 0 reactions 0 assignees View on GitHub
documentation examples help wanted
Dominant language
TypeScript
Stars
0
Forks
0
Avg merge
8d 13h
Merged PRs (30d)
17

Description

We need practical examples showing how to use this project in real-world environments.

Suggested examples:

* Local development using `.env`
* GitHub Actions validation step without `.env`
* Kubernetes deployment
* HashiCorp Nomad job

The goal is to create an `examples/` directory with one folder per environment.

Suggested structure:

```txt
examples/
├── local-env/
├── github-actions/
├── kubernetes/
└── hashicorp-nomad/
```

Each example should include a small `README.md` explaining:

* What the example does
* How to run it
* Which environment variables are required
* Expected success and failure behavior

Important: `.env` files should only be used for local development. CI/CD and production examples should use environment variables, secrets, or secret managers instead.

> Contributors can start by adding just one example.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the repository structure and the issue's proposed examples/ layout. Add one environment folder, such as local-env, github-actions, or kubernetes, with a README.md covering its purpose, usage, required environment variables, and expected success and failure behavior. Keep .env usage limited to local development and document secret-based configuration for CI/CD or production.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, kubernetes, typescript
Domain
ci-cd, devops, documentation, infrastructure
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.