Skip to content
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.

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

Improved Doc for docker-compose and secrets #816

Closed
wants to merge 0 commits into from

Conversation

filopedraz
Copy link

@filopedraz filopedraz commented Nov 20, 2023

Description

  • Improved doc to include docker-compose
  • Included reference on how to set default secrets
  • Fixed docker-compose and removed proxy.

Copy link
Contributor

@jecluis jecluis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm - @m-ildefons mind taking a look to confirm?

@jecluis
Copy link
Contributor

jecluis commented Nov 20, 2023

@filopedraz Thanks for the submission. For us to be able to merge your contribution, we'll need you to provide the commit with a DCO (see https://wiki.linuxfoundation.org/dco ). This can come in the form of adding a Signed-off-by: Your Name <[email protected]> in the commit message.

@jecluis jecluis added kind/enhancement Change that positively impacts existing code area/docs Related with documentation in general labels Nov 20, 2023
@filopedraz
Copy link
Author

I tried to run the docker-compose but it didn't work. Some issues with the proxy and an env variable wrongly passed. I updated the description above. You can check my last commit as well.

@jecluis
Copy link
Contributor

jecluis commented Nov 21, 2023

@filopedraz thanks for the DCO on your latest commit. Unfortunately you'll need to sign-off all the commits. May I suggest a clean branch, cherry-pick individual commits, run a git commit --amend on each, and add the Signed-off-by:? That might be the easiest approach given the small number of commits involved in this patch set.

@jecluis
Copy link
Contributor

jecluis commented Nov 21, 2023

Also, linting the docker-compose.yaml file has failed. Please consider the following error:

Run pre-commit run --show-diff-on-failure --color=always --files README.md docker-compose.yaml
  pre-commit run --show-diff-on-failure --color=always --files README.md docker-compose.yaml
  shell: /usr/bin/bash --noprofile --norc -e -o pipefail {0}
trim trailing whitespace....................................................Failed
- hook id: trailing-whitespace
- exit code: 1
- files were modified by this hook

on lines

diff --git a/docker-compose.yaml b/docker-compose.yaml
index 8a3187c..73ffe50 100644
--- a/docker-compose.yaml
+++ b/docker-compose.yaml
@@ -22,6 +22,6 @@ services:
       - "8080:8080"
     environment:
       S3GW_SERVICE_URL: "http://s3gw:7480"
-      
+
 volumes:
   data:
Error: Process completed with exit code 1.

If you happen to install the pre-commit hook available on the repository, you may be able to verify whether the problem is fixed by running pre-commit run check-yaml --file docker-compose.yaml.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Related with documentation in general kind/enhancement Change that positively impacts existing code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants