added docs to use env file #2054
Conversation
README.md
Outdated
| > ```yaml | ||
| > minecraft: | ||
| > env_file: | ||
| > - ./minecraft-server.env |
There was a problem hiding this comment.
Actually .env is a special file that doesn't even need to be called out specifically:
I'm leaning towards that one being documented with just the api key and showing all the other variables can be in the compose file like normal.
I can be easily convinced otherwise since docker run still needs the env file specifically mentioned.
There was a problem hiding this comment.
that's a good point, i will indicate .env.
|
Updated the doc to, hopefully, explain how to use a Might want to consider changing for a single readme to use the wiki in github. can then break things down by server type, and such, so its not all in 1 huge file. but it does make it easier to find things with CTRL+F if you sort of know what you're looking for. ¯\(ツ)/¯ |
Indeed! There's been an open issue forever that I momentarily think about and then get overwhelmed 😀 |
If you have any idea of the structure, and what not, and want to create that wiki branch, i would be more than willing to help moving the docs. |
|
I was originally thinking of just using the wiki mechanism. What are your thoughts about that vs a documentation site generator like the I found for the issue: https://squidfunk.github.io/mkdocs-material/ ? |
|
I am not familiar with the mkdocs. I will look it over. high level, just looks like markdown files. only thing i can think of from a user standpoint is not having built-in navigation in github. but you could also just link to the docs, and make github specifically for the more technical side of it, like the code, issues, and discussions |
|
I have zero experience with that tool also 😀, so am more pondering the overall user experience of the "documentation site" tools vs github wiki. |
* master: Auto CurseForge, added docs to use env file (itzg#2054)
* master: Tweak level of new docs link (itzg#2063) updated the readme to include the link to the docs site. (itzg#2061) Update CF_API_KEY example for docker run (itzg#2060) With AUTO_CURSEFORGE handle modpacks not allowed for distribution by author (itzg#2059) Redacts sensitive headers from debugs like with AUTO_CURSEFORGE (itzg#2058) Downloads handle content disposition filename with RFC 2047 encoding (itzg#2057) Auto CurseForge, added docs to use env file (itzg#2054)
documents #2048