chore: lint Dockerfile and add documentation/examples #51
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
azgaviperr
commented
Aug 30, 2025
azgaviperr
commented
- Applied linting to the Dockerfile for better readability and consistency.
- Updated README.md with additional details. ( lot of it )
- Added multiple docker-compose example files:
- docker-compose-config-variable-only.yml
- docker-compose-multiple-servers-env-files.yml
- docker-compose-multiple-servers-env-variables.yml
- docker-compose-single-server.yml
- Included an example environment file (env_example) for reference.
- Applied linting to the Dockerfile for better readability and consistency.
- Updated README.md with additional details. ( lot of it )
- Added multiple docker-compose example files:
- docker-compose-config-variable-only.yml
- docker-compose-multiple-servers-env-files.yml
- docker-compose-multiple-servers-env-variables.yml
- docker-compose-single-server.yml
- Included an example environment file (env_example) for reference.
Author
|
I made this documentation to help few persons. It's made on my notes. If needed I can split it in a docs/ folder to make it more digest. |
- Restructured documentation into separate sections for better organization:
- Added `docs/advanced-usage/index.md`
- Added `docs/configuration-guide/index.md`
- Added `docs/getting-started/index.md`
- Added `docs/index.md`
- Added `docs/troubleshooting/index.md`
- Renamed example files for clarity and consistency:
- Moved and renamed `docker-compose-examples/docker-compose-multiple-servers-env-files.yml` to `examples/docker-compose-multiple-servers-env-files.yml`
- Moved and renamed `docker-compose-examples/docker-compose-multiple-servers-env-variables.yml` to `examples/docker-compose-multiple-servers-env-variables.yml`
- Moved and renamed `docker-compose-examples/docker-compose-single-server.yml` to `examples/docker-compose-single-server.yml`
- Moved and renamed `docker-compose-examples/docker-compose-config-variable-only.yml` to `examples/docker-compose-static-config.yml`
- Moved `env_example` to `examples/env_example`
- Updated `README.md` and `docker-compose.yml` to reflect these changes.
Author
|
Documentation should be much nicer to review and use now. Let me know. |
hafometh88
reviewed
Sep 1, 2025
Contributor
hafometh88
left a comment
hafometh88
left a comment
There was a problem hiding this comment.
Expanding the docs is a good idea, but this has a lot of unnecessary filler in my opinion
Co-authored-by: hafometh88 <[email protected]>
Co-authored-by: hafometh88 <[email protected]>
Co-authored-by: hafometh88 <[email protected]>
Co-authored-by: hafometh88 <[email protected]>
Co-authored-by: hafometh88 <[email protected]>
Co-authored-by: hafometh88 <[email protected]>
Co-authored-by: hafometh88 <[email protected]>
Co-authored-by: hafometh88 <[email protected]>
Co-authored-by: hafometh88 <[email protected]>
Incorporated suggestions from @hafometh88 to improve clarity and detail in the advanced usage documentation.
Removed redundant double quotes from port mapping values in the example Docker Compose files for improved clarity and consistency.
Author
What do you think about it now ? Any other unnecessary filler ? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.