Skip to content

Inform developers of defaults YAML option #4525

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

Open
wants to merge 2 commits into
base: docs-staging
Choose a base branch
from

Conversation

1000TurquoisePogs
Copy link
Member

@1000TurquoisePogs 1000TurquoisePogs commented Jun 13, 2025

This is a small update to suggest a pattern I've seen extenders do that has been useful to them.
By shipping their own defaults YAML file, and telling users to append it to the overall config, they can reduce user actions upon installing an extension.

files changed
docs/extend/packaging-zos-extensions.md

Copy link

😺 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 Jun 13, 2025

@github-actions github-actions bot temporarily deployed to pull request June 13, 2025 12:07 Inactive
@1000TurquoisePogs 1000TurquoisePogs added area: misc This issue is a miscelleneous doc requirement not for a specific component or area review: doc Needs review by Doc Squad member release: V3 Zowe V3 content labels Jun 13, 2025

For examples of manifests thoughout Zowe GitHub repositories, see the following links:

- [API Catalog manifest.yaml](https://github.com/zowe/api-layer/blob/v2.x.x/api-catalog-package/src/main/resources/manifest.yaml)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Signed-off-by: 1000TurquoisePogs <[email protected]>
@github-actions github-actions bot temporarily deployed to pull request June 17, 2025 12:14 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: misc This issue is a miscelleneous doc requirement not for a specific component or area release: V3 Zowe V3 content review: doc Needs review by Doc Squad member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants