Skip to content

Commit f91f498

Browse files
johnitvnjohnitvn
committed
docs: update document
1 parent 0747796 commit f91f498

File tree

15 files changed

+475
-56
lines changed

15 files changed

+475
-56
lines changed

‎README.md

Lines changed: 39 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -10,42 +10,50 @@
1010
[![Contributors][contributors-shield]][contributors-url]
1111
[![MIT License][license-shield]][license-url]
1212

13-
Development infrastructure projects monorepo. This repo containt prebuilt devcontainer images, devcontainer features, nx plugins.
13+
Development infrastructure projects monorepo. This repo containt prebuilt devcontainer images, devcontainer features, docker images, nx plugins.
1414

1515
This project is mainly used internally within ebizbase projects but we have decided to share the entire source code of the project for the community to use and contribute.
1616

1717
## List of packages
1818

1919
### devcontainer features
2020

21-
| Name | Description|
22-
| ---------- | ---------- |
23-
| [omz-plugin][omz-plugin-readme] | This feature will install and active plugins for oh my zsh |
24-
| [install-npm-package-globally][install-npm-package-globally-readme] | This feature will be install npm packages globally |
25-
| [powerlevel10k][powerlevel10k-readme] | This feature will install, activate and config powerlevel10k theme for oh my zsh |
26-
| [npm-playwright][npm-playwright-readme] | This feature will be install playwright via npm with os dependencies and browser binaries |
21+
| Name | Description |
22+
| ------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
23+
| [omz-plugin][omz-plugin-readme] | This feature will install and active plugins for oh my zsh |
24+
| [install-npm-package-globally][install-npm-package-globally-readme] | This feature will be install npm packages globally |
25+
| [powerlevel10k][powerlevel10k-readme] | This feature will install, activate and config powerlevel10k theme for oh my zsh |
26+
| [npm-playwright][npm-playwright-readme] | This feature will be install playwright via npm with os dependencies and browser binaries |
2727

28+
### devcontainer images
2829

29-
### devconainer images
30+
| Name | Description |
31+
| ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
32+
| [base-devcontainer][base-devcontainer-readme] | The [`base-devcontainer`][base-devcontainer-readme] is a prebuild devcontainer image base on debian with common-utils and provide good experiences interacting with the zsh shell |
33+
| [node-devcontainer][node-devcontainer-readme] | The image base on [`base-devcontainer`][base-devcontainer-readme] with latest NodeJS LTS version (includes npm, pnpm, yarn, bun) |
34+
| [node-dind-devcontainer][node-dind-devcontainer-readme] | The image base on [`node-devcontainer`][node-devcontainer-readme] with docker in docker |
35+
| [node-dind-playwright-devcontainer][node-dind-playwright-devcontainer-readme] | The image base on [`node-dind-devcontainer`][node-dind-devcontainer-readme] with playwright installed (both OS dependencies and browser binary) |
36+
| [node-playwright-devcontainer][node-playwright-devcontainer-readme] | The image base on [`node-devcontainer`][node-devcontainer-readme] with playwright installed (both OS dependencies and browser binary) |
3037

31-
| Name | Description|
32-
| ---------- | ---------- |
33-
| [base-devcontainer][base-devcontainer-readme] | The `base-devcontainer` is a prebuild devcontainer image base on debian with common-utils and provide good experiences interacting with the zsh shell |
34-
| [node-devcontainer][node-devcontainer-readme] | The image base on `base-devcontainer` with latest NodeJS LTS version (includes npm, pnpm, yarn, bun) |
35-
| [node-dind-devcontainer][node-dind-devcontainer-readme] |The image base on `node-devcontainer` with docker in docker |
36-
| [node-dind-playwright-devcontainer][node-dind-playwright-devcontainer-readme] |The image base on `node-dind-devcontainer` with playwright installed (both OS dependencies and browser binary) |
37-
[node-playwright-devcontainer][node-playwright-devcontainer-readme] |The image base on `node-devcontainer` with playwright installed (both OS dependencies and browser binary) |
38+
### docker images
39+
40+
| Name | Description |
41+
| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
42+
| [node-distroless][node-distroless-readme] | This image combines the compactness and security of distroless with the convenience of dumb-init for process management, making Node.js applications run more stably in a container environment. |
43+
| [nginx-spa][node-distroless-readme] | This docker image can be used for single page apps. It serves your index.html if no other file matches. |
3844

3945
### npm packages
40-
| Name | Description|
41-
| ---------- | ---------- |
42-
| [nx-devkit][nx-devkit-readme] | It contains many utility functions for interactive with nx workspace and projects |
46+
47+
| Name | Description |
48+
| ----------------------------- | --------------------------------------------------------------------------------- |
49+
| [nx-devkit][nx-devkit-readme] | It contains many utility functions for interactive with nx workspace and projects |
4350

4451
### nx plugins
45-
| Name | Description|
46-
| ---------- | ---------- |
47-
| [nx-docker][nx-docker-readme] | The NX plugin to build and push docker image
48-
| [nx-dive][nx-dive-readme] | The NX plugin exploring a docker image, layer contents, and discovering ways to shrink the size of your Docker/OCI image base on [dive](https://github.com/wagoodman/dive)
52+
53+
| Name | Description |
54+
| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
55+
| [nx-docker][nx-docker-readme] | The NX plugin to build and push docker image |
56+
| [nx-dive][nx-dive-readme] | The NX plugin exploring a docker image, layer contents, and discovering ways to shrink the size of your Docker/OCI image base on [dive](https://github.com/wagoodman/dive) |
4957

5058
<p align="right">(<a href="#readme-top">back to top</a>)</p>
5159

@@ -81,19 +89,17 @@ Distributed under the MIT License. See [LICENSE][license-url] for more informati
8189
[license-shield]: https://img.shields.io/github/license/ebizbase/dev-infras.svg
8290
[license-url]: https://github.com/ebizbase/dev-infras/blob/main/LICENSE.txt
8391
[contribution-guidelines-url]: https://github.com/ebizbase/dev-infras/blob/main/CONTRIBUTING.md
84-
[npm-playwright-readme]:https://github.com/ebizbase/dev-infras/blob/main/devcontainer-features/npm-playwright/README.md
92+
[npm-playwright-readme]: https://github.com/ebizbase/dev-infras/blob/main/devcontainer-features/npm-playwright/README.md
8593
[omz-plugin-readme]: https://github.com/ebizbase/dev-infras/blob/main/devcontainer-features/omz-plugin/README.md
8694
[install-npm-package-globally-readme]: https://github.com/ebizbase/dev-infras/blob/main/devcontainer-features/install-npm-package-globally/README.md
8795
[powerlevel10k-readme]: https://github.com/ebizbase/dev-infras/blob/main/devcontainer-features/powerlevel10k/README.md
88-
89-
[base-devcontainer-readme]:https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/base-devcontainer/README.md
90-
[node-devcontainer-readme]:https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/node-devcontainer/README.md
91-
[node-dind-devcontainer-readme]:https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/node-dind-devcontainer/README.md
92-
[node-playwright-devcontainer-readme]:https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/node-playwright-devcontainer/README.md
93-
[node-dind-playwright-devcontainer-readme]:https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/node-dind-playwright-devcontainer/README.md
94-
95-
96+
[base-devcontainer-readme]: https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/base-devcontainer/README.md
97+
[node-devcontainer-readme]: https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/node-devcontainer/README.md
98+
[node-dind-devcontainer-readme]: https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/node-dind-devcontainer/README.md
99+
[node-playwright-devcontainer-readme]: https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/node-playwright-devcontainer/README.md
100+
[node-dind-playwright-devcontainer-readme]: https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/node-dind-playwright-devcontainer/README.md
96101
[nx-devkit-readme]: https://github.com/ebizbase/dev-infras/blob/main/packages/nx-devkit/README.md
97-
98102
[nx-docker-readme]: https://github.com/ebizbase/dev-infras/blob/main/packages/nx-docker/README.md
99-
[nx-dive-readme]: https://github.com/ebizbase/dev-infras/blob/main/packages/nx-dive/README.md
103+
[nx-dive-readme]: https://github.com/ebizbase/dev-infras/blob/main/packages/nx-dive/README.md
104+
[node-distroless-readme]: https://github.com/ebizbase/dev-infras/blob/main/images/node-distroless/README.md
105+
[nginx-spa-readme]: https://github.com/ebizbase/dev-infras/blob/main/images/nginx-spa/README.md

‎devcontainer-features/install-npm-package-globally/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,33 @@ Install semver version
3939
| Options Id | Description | Type | Default |
4040
| ---------- | ------------------------------------------------------------------------------------------------------------------------------- | ----- | ------- |
4141
| packages | List of npm packages to install globally sparate by comma. We accept specific version with semver (eg 'typescript,nx@^20.0.12') | array | [] |
42+
43+
## Contributing
44+
45+
We welcome contributions! Fork the repo, create a pull request, or open an issue with the "enhancement" tag. See [Contribution Guidelines][contribution-guidelines-url] for details.
46+
47+
## Issues
48+
49+
If you encounter any issues while using this feature, please check the following before creating a new issue:
50+
- Ensure your JSON configuration is correctly formatted. Refer to the Example Usage section for guidance.
51+
- Verify package name and version is avaiable
52+
53+
If the issue persists, feel free to:
54+
55+
- Open an issue on the [GitHub issues page][issues-url]
56+
- Provide detailed information, including:
57+
- A description of the issue.
58+
- Steps to reproduce the problem.
59+
- Logs or error messages, if applicable.
60+
- Your devcontainer setup (e.g., OS, DevContainer version).
61+
62+
Our team will review and address your issue as soon as possible. For faster resolution, ensure your report is clear and well-documented.
63+
64+
65+
## License
66+
67+
Distributed under the MIT License. See [LICENSE][license-url] for more information.
68+
69+
[issues-url]: https://github.com/ebizbase/dev-infras/issues
70+
[contribution-guidelines-url]: https://github.com/ebizbase/dev-infras/blob/main/CONTRIBUTING.md
71+
[license-url]: https://github.com/ebizbase/dev-infras/blob/main/LICENSE.txt

‎devcontainer-features/npm-playwright/README.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,34 @@ Install latest version
1010
"features": {
1111
"ghcr.io/ebizbase/devcontainer-features/npm-playwright:1": {}
1212
}
13-
```
13+
```
14+
15+
16+
## Contributing
17+
18+
We welcome contributions! Fork the repo, create a pull request, or open an issue with the "enhancement" tag. See [Contribution Guidelines][contribution-guidelines-url] for details.
19+
20+
## Issues
21+
22+
If you encounter any issues while using this feature, please check the following before creating a new issue:
23+
- Ensure your JSON configuration is correctly formatted. Refer to the Example Usage section for guidance.
24+
25+
If the issue persists, feel free to:
26+
27+
- Open an issue on the [GitHub issues page][issues-url]
28+
- Provide detailed information, including:
29+
- A description of the issue.
30+
- Steps to reproduce the problem.
31+
- Logs or error messages, if applicable.
32+
- Your devcontainer setup (e.g., OS, DevContainer version).
33+
34+
Our team will review and address your issue as soon as possible. For faster resolution, ensure your report is clear and well-documented.
35+
36+
37+
## License
38+
39+
Distributed under the MIT License. See [LICENSE][license-url] for more information.
40+
41+
[issues-url]: https://github.com/ebizbase/dev-infras/issues
42+
[contribution-guidelines-url]: https://github.com/ebizbase/dev-infras/blob/main/CONTRIBUTING.md
43+
[license-url]: https://github.com/ebizbase/dev-infras/blob/main/LICENSE.txt

‎devcontainer-features/omz-plugin/README.md

Lines changed: 40 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,23 @@
11
# omz-plugin devcontainer feature
22

3-
This feature will install and active plugins for oh my zsh
3+
Oh My Zsh is a delightful, open source, community-driven framework for managing your Zsh configuration. It comes bundled with thousands of helpful functions, helpers, plugins, themes.
4+
5+
This feature installs and activates plugins for Oh My Zsh. Helps enhance the command line experience and productivity
46

57
## Example Usage
68

79
```json
810
"features": {
911
"ghcr.io/ebizbase/devcontainer-features/omz-plugin:1": {
10-
"preInstalledPlugins": ["git", "git-auto-fetch"],
12+
"preInstalledPlugins": [
13+
"git",
14+
"git-auto-fetch"
15+
],
1116
"customPlugins": [
1217
"zsh-syntax-highlighting:https://github.com/zsh-users/zsh-syntax-highlighting.git",
1318
"zsh-autosuggestions:https://github.com/zsh-users/zsh-autosuggestions/archive/refs/tags/v0.7.1.zip"
1419
],
15-
"deleteInactive": false,
20+
"deleteInactive": false
1621
}
1722
}
1823
```
@@ -22,9 +27,40 @@ This feature will install and active plugins for oh my zsh
2227
| Options Id | Description | Type | Default |
2328
| ------------------- | --------------------------------------------------------------------------------------------- | ----- | ------- |
2429
| preInstalledPlugins | The list of pre-installed oh-my-zsh plugins to active (e.g. git,git-auto-fetch) (\*) | array | ["git"] |
25-
| customPlugins | The list of custom plugin you want to install with plugin-name1:url1,plugin-name2:url1 (\*\*) | array | [] |
30+
| customPlugins | The list of custom plugins you want to install, using the format `plugin-name:url` (\*\*) | array | [] |
2631
| deleteInactive | Should delete inactive plugins or not | bool | false |
2732

2833
**(\*)** See [list of oh-my-zsh preinstalled plugins](https://github.com/ohmyzsh/ohmyzsh/wiki/plugins)
2934

3035
**(\*\*)** We support zip release url or git url. See example [here](https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/base-devcontainer/devcontainer.json)
36+
37+
## Contributing
38+
39+
We welcome contributions! Fork the repo, create a pull request, or open an issue with the "enhancement" tag. See [Contribution Guidelines][contribution-guidelines-url] for details.
40+
41+
## Issues
42+
43+
If you encounter any issues while using this feature, please check the following before creating a new issue:
44+
- Ensure your JSON configuration is correctly formatted. Refer to the Example Usage section for guidance.
45+
- Verify the plugin URLs are accessible and valid (e.g., Git repository links or release ZIP URLs).
46+
47+
If the issue persists, feel free to:
48+
49+
- Open an issue on the [GitHub issues page][issues-url]
50+
- Provide detailed information, including:
51+
- A description of the issue.
52+
- Steps to reproduce the problem.
53+
- Logs or error messages, if applicable.
54+
- Your devcontainer setup (e.g., OS, DevContainer version).
55+
56+
Our team will review and address your issue as soon as possible. For faster resolution, ensure your report is clear and well-documented.
57+
58+
59+
## License
60+
61+
Distributed under the MIT License. See [LICENSE][license-url] for more information.
62+
63+
[issues-url]: https://github.com/ebizbase/dev-infras/issues
64+
[contribution-guidelines-url]: https://github.com/ebizbase/dev-infras/blob/main/CONTRIBUTING.md
65+
[license-url]: https://github.com/ebizbase/dev-infras/blob/main/LICENSE.txt
66+

‎devcontainer-features/powerlevel10k/README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,34 @@ You can define custom config file
3131
| config | Powerlevel10k configuration file url | string | https://raw.githubusercontent.com/ebizbase/dev-infras/refs/heads/main/devcontainer-features/powerlevel10k/p10k.zsh |
3232
| version | Powerlevel10k version | string | "latest" |
3333
| deletePreinstalledThemes | Should delete pre installed themes or not | boolean | false |
34+
35+
36+
## Contributing
37+
38+
We welcome contributions! Fork the repo, create a pull request, or open an issue with the "enhancement" tag. See [Contribution Guidelines][contribution-guidelines-url] for details.
39+
40+
## Issues
41+
42+
If you encounter any issues while using this feature, please check the following before creating a new issue:
43+
- Ensure your JSON configuration is correctly formatted. Refer to the Example Usage section for guidance.
44+
- Verify the config URL are accessible and valid.
45+
46+
If the issue persists, feel free to:
47+
48+
- Open an issue on the [GitHub issues page][issues-url]
49+
- Provide detailed information, including:
50+
- A description of the issue.
51+
- Steps to reproduce the problem.
52+
- Logs or error messages, if applicable.
53+
- Your devcontainer setup (e.g., OS, DevContainer version).
54+
55+
Our team will review and address your issue as soon as possible. For faster resolution, ensure your report is clear and well-documented.
56+
57+
58+
## License
59+
60+
Distributed under the MIT License. See [LICENSE][license-url] for more information.
61+
62+
[issues-url]: https://github.com/ebizbase/dev-infras/issues
63+
[contribution-guidelines-url]: https://github.com/ebizbase/dev-infras/blob/main/CONTRIBUTING.md
64+
[license-url]: https://github.com/ebizbase/dev-infras/blob/main/LICENSE.txt

0 commit comments

Comments
 (0)