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.

Sign up for GitHub

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

Jump to bottom

Enhancement/registry setup instructions #234

Merged
merged 27 commits into from
Jul 18, 2023
Merged

Enhancement/registry setup instructions #234

merged 27 commits into from
Jul 18, 2023

Conversation

quirogas
Copy link
Contributor

@quirogas quirogas commented Jul 13, 2023 •
edited
Loading

  • Break down the Troubleshooting and FAQ page into sections.
  • Fix anchor in documentation
  • Enhanced documentation to help users understand the need for containerized registries and redirect them to the guides that help them set up container registries.

resolves #225

Troubleshooting and FAQ page:

Before

Old Troubleshooting and FAQ page (everything on a single page)
image

After

Now the "Troubleshooting and FAQ" page has been broken into multiple pages with a contents page to help users find what they need, and the title has been updated to "Troubleshooting and FAQs".
image
image
image
image
image
image
image

Dependencies and Container Registry FAQ section:

Before

The "Dependencies" header in the "Get Started" page would send users to the "Why do I need a container registry" anchor, which was broken, and didn't add any further guidance to the users.
image
image

After

The Dependencies header has been renamed to Prerequisites, the anchor has been fixed, and it redirects users to a Container Registry-specific page. The "Why do I need a container registry" question now has a message that directs users to other places on the page where they can find help to set up their registries.
image
image

@quirogas quirogas added the enhancement New feature or request label Jul 13, 2023
@quirogas quirogas added this to the 1.0 GA milestone Jul 13, 2023
@quirogas quirogas self-assigned this Jul 13, 2023
@quirogas quirogas marked this pull request as ready for review July 14, 2023 16:57
kjrokos
kjrokos reviewed Jul 14, 2023
View reviewed changes
docs/troubleshooting_and_faq/build.md Outdated
Comment on lines 30 to 36
### Is there a way to cache data for subsequent collections?

The containerized adapter does not support caching data between collections.

### Can I implement on-demand collections?

The containerized adapter does not support on-demand collections.
Copy link
Contributor

Choose a reason for hiding this comment

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

These don't relate to building. I see they're also in the collections section, so probably a copy paste error

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've moved these to the collections section.

docs/troubleshooting_and_faq/index.md Outdated Show resolved Hide resolved
docs/troubleshooting_and_faq/vmware_aria_operations_platform.md Outdated Show resolved Hide resolved
docs/troubleshooting_and_faq/container_registries.md Outdated Show resolved Hide resolved
docs/troubleshooting_and_faq/docker.md Show resolved Hide resolved
docs/troubleshooting_and_faq/collections.md Outdated Show resolved Hide resolved
docs/troubleshooting_and_faq/docker.md

If you're having trouble with permissions on a Windows system, you can refer to the Docker documentation for instructions
on how to [Understand permission requirements for Windows](https://docs.docker.com/desktop/windows/permission-requirements/).

Copy link
Contributor

Choose a reason for hiding this comment

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

We may want to link to these from the mp-build and mp-test sections, as that's often when they'll occur

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've added the Docker daemon as part of the requirements and a warning that links to this issue in both mp-build and mp-test.

Copy link
Contributor

Choose a reason for hiding this comment

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

I like what you did, but I was actually referring to the troubleshooting sections - since that's what the focus is

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Alright, I added an admonition at the end of mp-test and mp-build's FAQs that redirect the users here.

@quirogas quirogas requested a review from kjrokos July 17, 2023 14:51
kjrokos
kjrokos reviewed Jul 17, 2023
View reviewed changes
docs/troubleshooting_and_faq/collections.md Outdated
Comment on lines 58 to 65

### Is there a way to cache data for subsequent collections?

The containerized adapter does not support caching data between collections.

### Can I implement on-demand collections?

The containerized adapter does not support on-demand collections.
Copy link
Contributor

Choose a reason for hiding this comment

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

These are duplicated

Copy link
Contributor Author

Choose a reason for hiding this comment

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

removed

@quirogas quirogas requested a review from kjrokos July 17, 2023 19:23
@quirogas quirogas merged commit 31ed2d1 into main Jul 18, 2023
14 checks passed
@quirogas quirogas deleted the enhancement/registry-setup-instructions branch July 18, 2023 13:03
@quirogas quirogas restored the enhancement/registry-setup-instructions branch July 25, 2023 04:20
@quirogas quirogas deleted the enhancement/registry-setup-instructions branch July 25, 2023 16:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MarkArbogast MarkArbogast MarkArbogast approved these changes

@kjrokos kjrokos kjrokos approved these changes

Assignees

@quirogas quirogas

Labels
cla-not-required enhancement New feature or request
Projects
None yet
Milestone
1.0 GA
Development

Successfully merging this pull request may close these issues.

Registry Setup Instructions
4 participants
@quirogas @MarkArbogast @kjrokos @vmwclabot