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

docs: add full working example tutorial in misc/deployment/ with link in intro #2225

Merged
merged 6 commits into from
Jun 17, 2023
Merged

docs: add full working example tutorial in misc/deployment/ with link in intro #2225

merged 6 commits into from
Jun 17, 2023

Conversation

rela-v
Copy link
Contributor

@rela-v rela-v commented Jun 16, 2023

Resolves #2222


The most important part of the docker-compose.yml creation step is to make sure that your docker-compose.yml file is properly formatted. One potential example docker-compose.yml file is as follows (be sure to delete any irrelevant lines to your application, or add any that you may need before copying and pasting the file contents). Be sure that the indentation is correct for every part of the file.

!!!note
Copy link
Contributor Author

Choose a reason for hiding this comment

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

There's a mistake here, missing a space! Didn't even notice it while I was pushing. Just letting you know that it is there.

Thank you once again for your attention towards this matter and for considering allowing me to contribute to this wonderful project.

@rela-v
Copy link
Contributor Author

rela-v commented Jun 16, 2023

Should be good now, let me know if there's any other changes that should be made prior to merge. Thank you so much again.

  • Rela

Copy link
Owner

@itzg itzg left a comment

Choose a reason for hiding this comment

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

This is great content!

It's such great content that it seems more like a technical article. I think I would prefer to see you publish this as your own article at Medium, dev.to, etc (I prefer dev.to these days). With that, it would be great to include a link to the article (and others) to this deployment section.

docs/index.md Outdated Show resolved Hide resolved
docs/misc/deployment/docker-compose-full-example.md Outdated Show resolved Hide resolved
docs/misc/deployment/docker-compose-full-example.md Outdated Show resolved Hide resolved
docs/misc/deployment/docker-compose-full-example.md Outdated Show resolved Hide resolved
docs/misc/deployment/docker-compose-full-example.md Outdated Show resolved Hide resolved
docs/misc/deployment/docker-compose-full-example.md Outdated Show resolved Hide resolved
docs/misc/deployment/docker-compose-full-example.md Outdated Show resolved Hide resolved
docs/misc/deployment/docker-compose-full-example.md Outdated Show resolved Hide resolved
docs/misc/deployment/docker-compose-full-example.md Outdated Show resolved Hide resolved
@rela-v
Copy link
Contributor Author

rela-v commented Jun 16, 2023

This is great content!

It's such great content that it seems more like a technical article. I think I would prefer to see you publish this as your own article at Medium, dev.to, etc (I prefer dev.to these days). With that, it would be great to include a link to the article (and others) to this deployment section.

Would you prefer a link in the intro, or to keep this section and have a short blurb wrapping the link?

rela-v and others added 2 commits June 16, 2023 10:54
accepting initial changes, will continue to revise and post dev.to article -- awaiting guidance on link location.

Co-authored-by: Geoff Bourne <itzgeoff@gmail.com>
@rela-v
Copy link
Contributor Author

rela-v commented Jun 16, 2023

All suggested changes were added: awaiting further guidance on the placement of the link.

Thank you so much for the amount of time and effort you put into giving feedback in this code review. I sincerely appreciate it and I am certain that this can help many people who would like to use your project!!

  • Rela

@itzg
Copy link
Owner

itzg commented Jun 16, 2023

Let's go with a combination of the ideas:

Under https://github.com/itzg/docker-minecraft-server/tree/master/docs/misc/deployment add an index.md that includes for now just a section for "supporting articles". Within that section I really the idea of not only the article link, but the short blurb around it. That can be a pattern for any other articles to link from here.

Thanks!

@rela-v
Copy link
Contributor Author

rela-v commented Jun 16, 2023

Let's go with a combination of the ideas:

Under https://github.com/itzg/docker-minecraft-server/tree/master/docs/misc/deployment add an index.md that includes for now just a section for "supporting articles". Within that section I really the idea of not only the article link, but the short blurb around it. That can be a pattern for any other articles to link from here.

Thanks!

Definitely - I've added the blurb in the new index.md file per your recommendation, thank you so much for your time and for being so receptive!

  • Rela

Copy link
Owner

@itzg itzg left a comment

Choose a reason for hiding this comment

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

Very good!

@itzg itzg merged commit 55fb21c into itzg:master Jun 17, 2023
adamancini pushed a commit to adamancini/docker-minecraft-server that referenced this pull request Jul 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature Request: Example in Docs, Vanilla Server Spin-up Walkthrough
2 participants