-
Notifications
You must be signed in to change notification settings - Fork 144
Dividing mvd-configuration.md file into smaller topics #4787
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
base: master
Are you sure you want to change the base?
Dividing mvd-configuration.md file into smaller topics #4787
Conversation
Signed-off-by: arooshlele <[email protected]>
|
😺 Thank you for creating this PR! To publish your content to Zowe Docs, follow these required steps.
Need help? Contact the Doc Squad in the #zowe-doc Slack channel. |
…ork_Configuration_Page
Signed-off-by: arooshlele <[email protected]>
Signed-off-by: arooshlele <[email protected]>
Signed-off-by: arooshlele <[email protected]>
Signed-off-by: arooshlele <[email protected]>
Signed-off-by: arooshlele <[email protected]>
Signed-off-by: arooshlele <[email protected]>
Signed-off-by: arooshlele <[email protected]>
…ion-layer-client.md, setting-up-terminal-app-plugins.md Signed-off-by: arooshlele <[email protected]>
…plugin-configuration.md, logging-configuration.md Signed-off-by: arooshlele <[email protected]>
…trolling-access-to-apps.md Signed-off-by: arooshlele <[email protected]>
…plugins.md Signed-off-by: arooshlele <[email protected]>
Signed-off-by: arooshlele <[email protected]>
|
|
||
| The duration of the session is determined by the plugin used. Some plugins are capable of renewing the session prior to expiration, while others may have a fixed session length. | ||
|
|
||
| The session duration and expiration behavior of the default security plugin, `sso-auth`, is determined by API Medation Layer configuration if present, and otherwise upon ZSS configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2x: Medation -> Mediation
|
|
||
| For example: | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would suggest to provide full examples with yaml syntax:
```yaml
components:
app-server:
logLevels:
_zsf.routing: 0
_zsf.install: 0
```
```yaml
components:
zss:
logLevels:
_zss.traceLevel: 0
_zss.fileTrace: 1
```
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Martin-Zeithaml Thanks, Martin for providing feedback. I've incorporated your feedback.
CC: @gauravs-20 @ArooshLele
|
|
||
| The file `_defaultTN3270.json` within the `tn3270-ng2` app folder `/config/storageDefaults/sessions/` is deployed to the [configuration dataservice](../extend/extend-desktop/mvd-configdataservice.md) when the app-server runs for the first time. This file is used to tell the terminal what host to connect to by default. If you'd like to customize this default, you can edit the file directly within the configuration dataservice `<components.app-server.instanceDir>/org.zowe.terminal.tn3270/sessions/_defaultTN3270.json`. Or you can open the app, customize a session within the UI, click the save icon (floppy icon) and then copy that file from `<components.app-server.usersDir>/<your user>/org.zowe.terminal.tn3270/sessions/_defaultTN3270.json` to `<components.app-server.instanceDir>/org.zowe.terminal.tn3270/sessions/_defaultTN3270.json`. Either way, you will see a file with the following properties: | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing top level curly braces, same with the second example:
{
"host": <hostname>
"port": <port>
"security": {
type: <"telnet" or "tls">
}
}
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Martin-Zeithaml Thanks. Based on your feedback, the file has been updated. CC: @gauravs-20
1000TurquoisePogs
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will not comment on the content of the pages because it's unchanged. We can improve pages in later PRs.
My feedback is on organization.
When splitting our 1 advanced config page into many, I think we need some categorization to guide users to the topics they are interested in.
It's always hard to determine where content should go: user-guide/installing, using, extending...
For now we can keep everything in user-guide/installing. But let's categorize these topics somehow.
sidebars.js
Outdated
| type: "category", | ||
| label: "Advanced Application Framework Configuration", link: { type: "doc", id: "user-guide/mvd-configuration", }, | ||
| collapsed: false, | ||
| items: ["user-guide/accessing-zss", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
how about categorizing these pages somehow
app-server:
- "user-guide/managing-cluster-mode-for-app-server",
zss:
- "user-guide/accessing-zss"
- "user-guide/zss-configuration-1",
zis:
- "user-guide/using-multiple-zis-instances",
apps:
- "user-guide/app-plugin-configuration",
- "user-guide/setting-up-terminal-app-plugins",
administration:
- "user-guide/controlling-access-to-apps",
- "user-guide/controlling-access-to-dataservices",
- "user-guide/customizing-security-plugins",
- "user-guide/administering-the-servers-and-plugins-using-an-api",
- "user-guide/configuration-file",
- "user-guide/logging-configuration",
- "user-guide/network-configuration",
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Feedback about categorizing pages from Sean is noted. Thank you, Sean. @1000TurquoisePogs
@ArooshLele @gauravs-20 The Advanced Application Framework Configuration page is now divided into child pages for now. Further to Sean's feedback, I'll investigate the technical aspect of how to bunch the child pages under the related tabs and then open another Pull Request to do so.
…ork_Configuration_Page
…ork_Configuration_Page
…ork_Configuration_Page
Signed-off-by: ArooshLele <[email protected]>
Signed-off-by: ArooshLele <[email protected]>
Signed-off-by: ArooshLele <[email protected]>
Signed-off-by: ArooshLele <[email protected]>
Signed-off-by: ArooshLele <[email protected]>
…ork_Configuration_Page
…ork_Configuration_Page
Signed-off-by: arooshlele <[email protected]>
…tion_Page' of https://github.com/zowe/docs-site into MVD-7317_Split_Advanced_Application_Framework_Configuration_Page
Signed-off-by: arooshlele <[email protected]>
Signed-off-by: arooshlele <[email protected]>
Signed-off-by: arooshlele <[email protected]>
Signed-off-by: arooshlele <[email protected]>
List the file(s) included in this PR:
mvd-configuration.md
Describe your pull request here:
The mvd-configuration.md file has the Advanced Application Framework Configuration topic.
It is a large topic.
Following my discussion with Sean @1000TurquoisePogs , this large topic could be divided into smaller chunks/subtopics. The content stays the same.
The subtopic files would be as follows:
After creating the PR, follow the instructions in the comments.
@gauravs-20 @ArooshLele