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

Visualize "install" options as options under parent category #3935

Merged
merged 4 commits into from
Oct 9, 2024

Conversation

1000TurquoisePogs
Copy link
Member

@1000TurquoisePogs 1000TurquoisePogs commented Oct 8, 2024

Today you can install zowe servers via many techniques and either on or off of z/OS.
All these options are currently visualized on the sidebar like this
image

Since each one of these items is an option, you don't want to do more than one really. You want to choose one and only one.
To help make that obvious, I put them all under a parent item in the sidebar that just says "installing"
Then, I revised the titles to make clear what you're installing and how, so hopefully people will understand these are choices where you only choose one option.

Now it looks like this
image

Copy link

github-actions bot commented Oct 8, 2024

😺 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 Oct 8, 2024

📁 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.

@1000TurquoisePogs 1000TurquoisePogs added area: install and config Issues related to z/OS install and config release: V3 Zowe V3 content review: doc Needs review by Doc Squad member labels Oct 8, 2024
Copy link

github-actions bot commented Oct 8, 2024

@github-actions github-actions bot temporarily deployed to pull request October 8, 2024 20:20 Inactive
"user-guide/install-zowe-zos-convenience-build",
{
type: "category",
label: "Installing Zowe via a containerization build (PAX file)",
Copy link
Member Author

Choose a reason for hiding this comment

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

Note this was a bug: the container build never was a pax file.

@balhar-jakub
Copy link
Member

This looks like a great improvement to me.

@janan07 janan07 self-requested a review October 9, 2024 14:14
Copy link
Collaborator

@janan07 janan07 left a comment

Choose a reason for hiding this comment

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

This is good. It makes the installation options in the sidebar more legible.

@github-actions github-actions bot temporarily deployed to pull request October 9, 2024 14:22 Inactive
@janan07 janan07 merged commit 7612713 into master Oct 9, 2024
4 checks passed
@janan07 janan07 deleted the install-options branch October 9, 2024 14:22
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 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