Skip to content

Update readme for docs - #2061

Merged
itzg merged 2 commits into
itzg:masterfrom
camalot:update-readme-for-docs
Apr 4, 2023
Merged

Update readme for docs#2061
itzg merged 2 commits into
itzg:masterfrom
camalot:update-readme-for-docs

Conversation

@camalot

@camalot camalot commented Apr 3, 2023

Copy link
Copy Markdown
Contributor

Added a link at the top of the readme to the new documentation site.

Should the rest of the readme be "cleared" out, or just contain some basic info, or stay as it is?

camalot added 2 commits April 3, 2023 10:40
* master:
  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)
@itzg

itzg commented Apr 3, 2023

Copy link
Copy Markdown
Owner

It makes me nervous 😀, but does seem like clearing out the rest of the docs is the best way to avoid duplicate effort with updates. I'm thinking "Intro" would be the only section that would remain with perhaps your new link just below that. I wish I could remember where I generated this image that use in the Docker Hub README: that

@camalot

camalot commented Apr 3, 2023

Copy link
Copy Markdown
Contributor Author

Maybe rename README for the time being. so that the full docs are available (in case anything was missed)

@itzg

itzg commented Apr 3, 2023

Copy link
Copy Markdown
Owner

Maybe rename README for the time being. so that the full docs are available (in case anything was missed)

Great idea. Would you prefer I do the big switcheroo to make it "official"?

@camalot

camalot commented Apr 3, 2023

Copy link
Copy Markdown
Contributor Author

how ever you want to do it.

@itzg itzg left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Forgot to actually merge this one...got distracted with the discussion I started 😀

@itzg
itzg merged commit 195d352 into itzg:master Apr 4, 2023
@camalot
camalot deleted the update-readme-for-docs branch April 4, 2023 03:27
camalot added a commit to camalot/docker-minecraft-server that referenced this pull request Apr 4, 2023
* 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)
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.

2 participants