Skip to content

docs: add env lens #12

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.

Sign up for GitHub

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

Merged
vigneshrajsb merged 1 commit into from
Jan 18, 2026
+41 −22
Merged

docs: add env lens #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions src/pages/docs/schema/docker.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,13 +167,14 @@ services:

### Optional Fields

| Field | Type | Description |
| ------------ | ------ | ----------------------------------------------------------- |
| `command` | string | Override container entrypoint |
| `arguments` | string | Arguments passed to the command. Use `%%SPLIT%%` for spaces |
| `env` | object | Environment variables |
| `ports` | array | Exposed container ports |
| `deployment` | object | Deployment configuration (see below) |
| Field | Type | Description |
| ------------ | ------- | ----------------------------------------------------------- |
| `command` | string | Override container entrypoint |
| `arguments` | string | Arguments passed to the command. Use `%%SPLIT%%` for spaces |
| `env` | object | Environment variables |
| `ports` | array | Exposed container ports |
| `deployment` | object | Deployment configuration (see below) |
| `envLens` | boolean | Enable environment lens ingress banner |

## Deployment Options

Expand Down
17 changes: 17 additions & 0 deletions src/pages/docs/schema/github.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,23 @@ Persistent volume mounts for stateful data:
| `accessModes` | No | `ReadWriteOnce` or `ReadWriteMany` |
| `medium` | No | Storage medium |

## Fields Reference

### Required Fields

| Field | Type | Description |
| ------------ | ------ | ---------------------------------------- |
| `repository` | string | GitHub repository in `owner/repo` format |
| `branchName` | string | Branch to build from |
| `docker` | object | Docker build configuration (see above) |

### Optional Fields

| Field | Type | Description |
| ------------ | ------- | -------------------------------------- |
| `deployment` | object | Deployment configuration (see above) |
| `envLens` | boolean | Enable environment lens ingress banner |

## Template Variables

Reference other services in your configuration using template variables. See the [Template Variables](/docs/features/template-variables) guide for the complete list.
Expand Down
31 changes: 16 additions & 15 deletions src/pages/docs/schema/helm.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,21 +243,22 @@ Configuration for the main application container:

Configuration for an init container that runs before the main application. Uses the same fields as `docker.app`.

## Complete Fields Reference

| Field | Type | Required | Description |
| ------------------ | ------ | ---------- | ------------------------- |
| `chart.name` | string | **Yes** | Chart name or path |
| `chart.repoUrl` | string | For public | Helm repository URL |
| `chart.version` | string | No | Chart version |
| `chart.values` | array | No | Inline Helm values |
| `chart.valueFiles` | array | No | Value file paths |
| `repository` | string | For builds | GitHub repository |
| `branchName` | string | For builds | Branch to build from |
| `docker` | object | No | Docker build config |
| `args` | string | No | Additional Helm arguments |
| `version` | string | No | Helm CLI version |
| `deploymentMethod` | string | No | `"native"` or `"ci"` |
## Fields Reference

| Field | Type | Required | Description |
| ------------------ | ------- | ---------- | -------------------------------------- |
| `chart.name` | string | **Yes** | Chart name or path |
| `chart.repoUrl` | string | For public | Helm repository URL |
| `chart.version` | string | No | Chart version |
| `chart.values` | array | No | Inline Helm values |
| `chart.valueFiles` | array | No | Value file paths |
| `repository` | string | For builds | GitHub repository |
| `branchName` | string | For builds | Branch to build from |
| `docker` | object | No | Docker build config |
| `args` | string | No | Additional Helm arguments |
| `version` | string | No | Helm CLI version |
| `deploymentMethod` | string | No | `"native"` or `"ci"` |
| `envLens` | boolean | No | Enable environment lens ingress banner |

## Templated Variables

Expand Down