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.

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

Jump to bottom

Misleading Doc: On sidecars, the depends_on attributes is not on image attribute #5945

Open
alquerci opened this issue Sep 27, 2024 · 2 comments · May be fixed by #5950
Open

Misleading Doc: On sidecars, the depends_on attributes is not on image attribute #5945

alquerci opened this issue Sep 27, 2024 · 2 comments · May be fixed by #5950

Comments

@alquerci
Copy link

Actual

On the doc
https://aws.github.io/copilot-cli/docs/developing/sidecars/#image-depends-on

image:
  build: ./Dockerfile
  depends_on:
    nginx: start
    startup: success

image

Expected/Working

sidecars:
  some_sidecar:
    image:
      build: ./Dockerfile
    depends_on:
      nginx: start
      startup: success
@Lou1415926
Copy link
Contributor

hi @alquerci ! Good eyes - thank you very much for reporting this! While we pick this up, feel free to contribute a PR too! Contributions are always welcomed and very appreciated. It should be removed from

copilot-cli/site/content/docs/include/image-config.en.md

Line 44 in b1c4c42

<span class="parent-field">image.</span><a id="image-depends-on" href="#image-depends-on" class="field">`depends_on`</a> <span class="type">Map</span>
and added to https://github.com/aws/copilot-cli/blob/mainline/site/content/docs/include/sidecar-config.en.md.

Thanks again for spotting this!

@alquerci
Copy link
Author

alquerci commented Oct 7, 2024 •
edited
Loading

@Lou1415926 well it is not so simple.

The template image is good. But it is included inside sidecars template. Only on sidecars depends_on is not present inside image.

It was a good idea to avoid duplication.

So a way to keep avoiding duplication is creating an abstract common image template with same fields used on both concrete image Map.

I accept your invitation to contribute.

alquerci added a commit to alquerci/copilot-cli that referenced this issue Oct 7, 2024
@alquerci
docs(site): On sidecars, the depends_on attributes is not on image at…
339a733 
…tribute (aws#5945)
@alquerci alquerci linked a pull request Oct 7, 2024 that will close this issue
Open
alquerci added a commit to alquerci/copilot-cli that referenced this issue Oct 7, 2024
@alquerci
docs(site): On sidecars, the depends_on attributes is not on image at…
d174012 
…tribute (aws#5945)
alquerci added a commit to alquerci/copilot-cli that referenced this issue Oct 7, 2024
@alquerci
docs(site): On sidecars, the depends_on attribute is not on image map (…
590e8e5 
…aws#5945)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(site): On sidecars, the depends_on attribute is not on image map (#5945) alquerci/copilot-cli
2 participants
@alquerci @Lou1415926