docs: improve readme #357
Merged
docs: improve readme #357
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
johnstcn
approved these changes
Sep 26, 2024
matifali
reviewed
Sep 26, 2024
Comment on lines
+99
to
+105
| | Name | Description | Known Issues | | ||
| | ------------------------ | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | | ||
| | Volume mounts | Volumes are used to persist data and share directories between the host and container. | [#220](https://github.com/coder/envbuilder/issues/220) | | ||
| | Port forwarding | Port forwarding allows exposing container ports to the host, making services accessible. | [#48](https://github.com/coder/envbuilder/issues/48) | | ||
| | Script init & Entrypoint | `init` adds a tiny init process to the container, and `entrypoint` sets a script to run at container startup. | [#221](https://github.com/coder/envbuilder/issues/221) | | ||
| | Customizations | Product-specific properties, e.g., _VS Code_ settings and extensions. | [#43](https://github.com/coder/envbuilder/issues/43) | | ||
| | Composefile | Define multiple containers and services for more complex development environments. | [#236](https://github.com/coder/envbuilder/issues/236) | |
There was a problem hiding this comment.
We should make sure we keep this table updated as the issues gets resolved.
matifali
reviewed
Sep 26, 2024
| - `build`: Builds and tags `envbuilder:latest` for your current architecture. | ||
| - `develop`: Runs `envbuilder:latest` against a sample Git repository. | ||
| - `test`: Runs tests. | ||
| - `test-registry`: Stands up a local registry for caching images used in tests. |
Co-authored-by: Cian Johnston <[email protected]>
Co-authored-by: Muhammad Atif Ali <[email protected]>
|
Also closes #328 |
Closed
Closed
mafredri
pushed a commit
that referenced
this pull request
Oct 2, 2024
Co-authored-by: Cian Johnston <[email protected]> Co-authored-by: Muhammad Atif Ali <[email protected]> (cherry picked from commit 63a383b)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes coder/internal#59