docs-site icon indicating copy to clipboard operation
docs-site copied to clipboard

RUNTIME_DIR confusion with ROOT_DIR

Open 1000TurquoisePogs opened this issue 4 years ago • 3 comments

Description

In the zowe server components documentation, there's reoccurring reference to something called "RUNTIME_DIR" For example: https://docs.zowe.org/stable/user-guide/install-zowe-zos-convenience-build.html#step-2-choose-a-runtime-uss-folder

However, in our code this is always called ROOT_DIR. It appears to have the same meaning but a different word is used. I can see this being a point of confusion if we're telling users about ROOT_DIR but they don't see references to it. In one point of the doc, it even shows that the two are the same: "the ROOT_DIR= value in instance.env will be updated to reference the <RUNTIME_DIR>"

Pages to Update

https://docs.zowe.org/stable/user-guide/install-zowe-zos-convenience-build.html#step-2-choose-a-runtime-uss-folder https://docs.zowe.org/stable/user-guide/upgrade-zos-system.html#upgrading-the-instance-directory Not an exhaustive list, I'm not sure how many pages are effected.

Screenshots

Expected behavior

Additional context

1000TurquoisePogs avatar Apr 15 '21 14:04 1000TurquoisePogs

Hi @1000TurquoisePogs can i work on this issue. Please assign me this issue.

AbhishekJamhoriya avatar Oct 15 '21 09:10 AbhishekJamhoriya

Hey @AbhishekJamhoriya will you still be working on this? Otherwise, a different Doc member will take responsibility

DivergentEuropeans avatar Sep 05 '23 14:09 DivergentEuropeans

Note: if ROOT_DIR occurs anywhere in v2, it should not be replaced with RUNTIME_DIR, which is a v1 thing. For v2, it is instead zowe.runtimeDirectory

1000TurquoisePogs avatar Sep 12 '23 13:09 1000TurquoisePogs