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

Create appendix for list of zowe's datasets #4147

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

1000TurquoisePogs
Copy link
Member

@1000TurquoisePogs 1000TurquoisePogs commented Feb 3, 2025

Resolves #3719

This ticket collects information about zowe datasets and puts it in one appendix so that it can be referenced in a way that does not conflict with the user's chosen install type.

Before this PR, information about certain datasets was included (incompletely) in both SMPE and convenience build install pages.
While the tables were useful, referencing them from elsewhere could result in an issue where someone might be brought to a convenience build reference when using SMPE instead, or vice versa.

Putting the information into an appendix allows it to be referenced in a neutral way to both install types.

It also will be useful in the future for handling documentation about upgrades and downgrades as in zowe/community#2305

This is a draft open to all feedback.
This would apply to both V2 and V3, but I havent made such updates without first gathering feedback.

Copy link

github-actions bot commented Feb 3, 2025

😺 Thank you for creating this PR! To publish your content to Zowe Docs, follow these required steps.

  • Add the label review: doc.
  • Identify your content topic with a label. (Examples: area: apiml, area: cli, area: install and config, etc.)
  • Specify the major Zowe release(s) for your content. (Examples: release: V1, release: V2, release: V3)
    • If adding content that needs to be removed from V3 documentation, add the V3 N/A tag.
  • Select the master branch if your PR updates content that is on the live site. Select docs-staging if your PR updates content for a future release.
  • Notify the Doc Squad about this PR. If you don't know whom should review your content, message the #zowe-doc Slack channel. If you know which Doc Squad writer should approve your content, add that person as a reviewer.

Need help? Contact the Doc Squad in the #zowe-doc Slack channel.

Copy link

github-actions bot commented Feb 3, 2025

📁 The PR description is missing the file name(s) for the updated content. List all the files included in this PR so this information displays in our Zowe Docs GitHub Slack channel.

If you have addressed this issue already, refresh this page in your browser to remove this comment.

Copy link

github-actions bot commented Feb 3, 2025

💾 The release label is missing. Add a release: label so your content is published with the correct major Zowe release.

If you have addressed this issue already, refresh this page in your browser to remove this comment.

@1000TurquoisePogs 1000TurquoisePogs added type: enhancement New feature or request area: install and config Issues related to z/OS install and config review: doc Needs review by Doc Squad member labels Feb 3, 2025
@1000TurquoisePogs
Copy link
Member Author

Also:

Our code and doc call some datasets "custom datasets" and i find this bizarre terminology.
Maybe it's just me. I'd prefer saying they're "instance datasets", but wont make that change now unless there's consensus.

Copy link

github-actions bot commented Feb 3, 2025

@github-actions github-actions bot temporarily deployed to pull request February 3, 2025 21:00 Inactive
…s into this appendix

Signed-off-by: 1000TurquoisePogs <[email protected]>
Signed-off-by: 1000TurquoisePogs <[email protected]>
@1000TurquoisePogs 1000TurquoisePogs marked this pull request as ready for review February 10, 2025 19:31
@github-actions github-actions bot temporarily deployed to pull request February 10, 2025 19:39 Inactive
@github-actions github-actions bot temporarily deployed to pull request February 11, 2025 20:00 Inactive
Signed-off-by: 1000TurquoisePogs <[email protected]>
@github-actions github-actions bot temporarily deployed to pull request February 11, 2025 20:34 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: install and config Issues related to z/OS install and config review: doc Needs review by Doc Squad member type: enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

SWZELOAD is not documented
3 participants