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

Docker-compose examples cleanup #731

Closed
joe-elliott opened this issue Jun 3, 2021 · 3 comments · Fixed by #740
Closed

Docker-compose examples cleanup #731

joe-elliott opened this issue Jun 3, 2021 · 3 comments · Fixed by #740
Assignees
Labels
type/docs Improvements or additions to documentation

Comments

@joe-elliott
Copy link
Member

The docker-compose examples were recently split out to have individual readmes which helps with readability, but all of the files are just jammed in the same folder: ./example/docker-compose.

Reorganize the examples into individual subfolders for clarity. For instance move:

example/docker-compose/docker-compose.agent.yaml
example/docker-compose/etc/agent.yaml
example/docker-compose/readme.agent.md

to

example/docker-compose/agent/docker-compose.yaml
example/docker-compose/agent/agent.yaml
example/docker-compose/agent/readme.md

Note that there are shared config files and relative paths that will need to be cleaned up.

@joe-elliott joe-elliott added the type/docs Improvements or additions to documentation label Jun 3, 2021
@yvrhdn yvrhdn self-assigned this Jun 4, 2021
@yvrhdn
Copy link
Member

yvrhdn commented Jun 4, 2021

I can pick this up :)

@joe-elliott
Copy link
Member Author

@kvrhdn Be careful when doing this. I noticed a fair number of these files are linked directly from our docs.

@yvrhdn
Copy link
Member

yvrhdn commented Jun 4, 2021

Oh, good call! I can find the links by searching the docs folder for example/docker-compose. I'll make sure to update them as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants