Skip to content
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

Link to documentation when possible #62

Open
1000TurquoisePogs opened this issue Oct 13, 2023 · 2 comments
Open

Link to documentation when possible #62

1000TurquoisePogs opened this issue Oct 13, 2023 · 2 comments
Milestone

Comments

@1000TurquoisePogs
Copy link
Member

Given a particular page (like one that does zwe init security), find the most appropriate documentation page, and have a button somewhere on the screen where people can click for more info.

Such as https://docs.zowe.org/stable/appendix/zwe_server_command_reference/zwe/init/zwe-init

https://docs.zowe.org/stable/user-guide/configure-certificates

@jp669844
Copy link

It would be great to add links as part of the JSON schema file, see an example.

              "stcs": {
              "type": "object",
              "additionalProperties": false,
              "description": "STC names",
       "documentation":"https://docs.zowe.org/stable/user-guide/install-stc-members/",
              "properties": {
               ...
              }
            }

At least on the "group" level, and where possible, on a variable level.
Design sample here:

image image

@jp669844 jp669844 added this to the ZEN 1.0.0 milestone Oct 25, 2023
@1000TurquoisePogs
Copy link
Member Author

I wonder if we should use a custom property for json schema like "link", which would be ignored by most schema parsers, but would mean to us that it's a doc link.

If not, then we'd need to put it in "description" and then we'd just need to neatly separate link from comment from example from details, etc.

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

No branches or pull requests

2 participants