fix: adding a server guide on installation location / layout #33604
Conversation
vmuzikar
left a comment
There was a problem hiding this comment.
@shawkins Thank you for the PR! I think this guide is a nice addition.
The README.md in our root directory could also be updated to have a link to this guide.
I was thinking about if we should have this guide only in the form of the README included in the root of the dist. That's probably the natural place I'd be looking for an info on the dir structure as a user. But then we have the container and the README there is not as accessible. So +1 for having this as a online guide and adding just a link to the README. We could do that as part of this PR even.
There's a note about the relative paths - I think a separate issue is needed if we want to change all existing relative paths to read as /path instead.
I think that's fine the way it is.
I was also wondering about backporting this. @ahus1 Do you think it's a valid action to add a guide in a micro release?
docs/guides/server/pinned-guides
Outdated
| @@ -1,3 +1,4 @@ | |||
| directory-structure | |||
There was a problem hiding this comment.
I would not place it so high. The first think user usually needs is configuration and admin user. I'd place it between bootstrap-admin-recovery and containers. WDYT?
| == Installation Locations | ||
|
|
||
| `/opt/keycloak` is the root install location for the server in all containerized usage shown for {project_name} including <@links.server id="containers"/> and the Getting Started Guides for Docker, Podman, Kubernetes, and OpenShift - see link:{gettingstarted_link_latest}[{gettingstarted_name_short}]. | ||
|
|
||
| If you are installing from a zip file then by default there will be an install root directory of `{archivebasename}-{version}`, which can be created anywhere you choose on your filesystem. |
There was a problem hiding this comment.
I'd swap this chapter with Directory Structure. It feels to me a bit odd to start a "Directory Structure" guide with a note where KC is placed in the container image.
There was a problem hiding this comment.
I was trying to first establish context about where the directory structure could be found. Would altenative wording help?
There was a problem hiding this comment.
I'd maybe at least swap the two paragraphs to have ZIP instructions first (at a more "natural" distribution).
There was a problem hiding this comment.
Ok, made that change.
Ok, I'll add that.
|
|
Let me know if the README link seems ok, or if it's good enough to be implied by the https://www.keycloak.org/guides#server link at the bottom |
closes: keycloak#32110 Signed-off-by: Steve Hawkins <[email protected]>
…k#33604) closes: keycloak#32110 Signed-off-by: Steve Hawkins <[email protected]> (cherry picked from commit fd89297)
…#34158) * fix: adding a server guide on installation location / layout (#33604) closes: #32110 Signed-off-by: Steve Hawkins <[email protected]> (cherry picked from commit fd89297) * adding getting started links Signed-off-by: Steve Hawkins <[email protected]> --------- Signed-off-by: Steve Hawkins <[email protected]>
closes: #32110
Calls out more clearly the usage of /opt/keycloak and provides an overview of what our directory structure looks like.
There's a note about the relative paths - I think a separate issue is needed if we want to change all existing relative paths to read as /path instead.
The README.md in our root directory could also be updated to have a link to this guide.
WDYT? @andymunro @vmuzikar @mabartos