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

docs: adds clarification to imageset reference and examples #555

Merged
merged 4 commits into from Feb 27, 2023
Merged

docs: adds clarification to imageset reference and examples #555

merged 4 commits into from Feb 27, 2023

Conversation

jpower432
Copy link
Contributor

Signed-off-by: Jennifer Power barnabei.jennifer@gmail.com

Description

This update imageset examples under docs/examples and updates the imageset-config-ref.yaml to provide valid catalog configuration examples.

Type of change

  • Bug fix (non-breaking change which fixes an issue) (Docs)

How Has This Been Tested?

N/A, docs PR

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@jpower432
docs: adds clarification to imageset reference and examples
add4d7c 
Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>
@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 27, 2023
@jpower432
docs: adds more operator channel specific examples to the example docs
bb3b13f 
Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>
@jpower432
docs: adds clarifying information about heads-only functionality
38cb213 
Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>
@jpower432 jpower432 changed the title [WIP] docs: adds clarification to imageset reference and examples docs: adds clarification to imageset reference and examples Jan 31, 2023
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 31, 2023
jharmison-redhat
jharmison-redhat reviewed Jan 31, 2023
View reviewed changes
Copy link
Contributor

@jharmison-redhat jharmison-redhat left a comment

Choose a reason for hiding this comment

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

A couple of typos and a few spots that I think could use additional clarity.

docs/imageset-config-ref.yaml Outdated
packages:
- name: elasticsearch-operator
channels:
- name: 'stable-v0' # Mirrors a single channel
Copy link
Contributor

Choose a reason for hiding this comment

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

Add clarity to comment

Mirrors a single channel, from the previous channel head to the current channel head

docs/examples/imageset-config-filter-catalog.yaml Outdated
# If a package is specified with a channel with no minVersion/maxVersion, only the channel's latest
# version will be mirrored.

# IMPORTANT: This is only true if metadata for this package in unestablished.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think repetition in multiple examples is good, but multiple times in same file is excessive imo

docs/imageset-config-ref.yaml Outdated
- name: rhacs-operator
minVersion: '3.67.0'
minVersion: '3.67.0' # Mirrors all version from the minimum version to the latest in the package
Copy link
Contributor

Choose a reason for hiding this comment

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

Add clarity

Mirrors all versions from the minimum version to the latest in the package, including all channels that contain any of those versions.

Consider addition of extra note - not here, but somewhere - that "minmum" and "latest" don't mean semver-style sorting, but rather relate to the graph constructed through 'replaces' and 'skips' in published versions

docs/examples/imageset-config-filter-catalog.yaml Outdated
channels:
- name: 'stable-v0'
---
#minVersion and maxVersion can be set that the channel level OR the package level. If set at the package level, all channels
Copy link
Contributor

Choose a reason for hiding this comment

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

can be set at

@jpower432
docs: addresses PR feedback
6042293 
Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>
sherine-k
sherine-k approved these changes Feb 6, 2023
View reviewed changes
Copy link
Contributor

@sherine-k sherine-k left a comment

Choose a reason for hiding this comment

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

This clarifies a lot. Thanks @jpower432
/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Feb 6, 2023
soltysh
soltysh approved these changes Feb 27, 2023
View reviewed changes
Copy link
Member

@soltysh soltysh left a comment

Choose a reason for hiding this comment

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

/approve

@openshift-ci
Copy link

openshift-ci bot commented Feb 27, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jpower432, sherine-k, soltysh

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 27, 2023
@openshift-ci
Copy link

openshift-ci bot commented Feb 27, 2023

@jpower432: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@openshift-merge-robot openshift-merge-robot merged commit b4d43ae into openshift:main Feb 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@soltysh soltysh soltysh approved these changes

@sherine-k sherine-k sherine-k approved these changes

@deejross deejross Awaiting requested review from deejross

@lmzuccarelli lmzuccarelli Awaiting requested review from lmzuccarelli

@jharmison-redhat jharmison-redhat Awaiting requested review from jharmison-redhat

Assignees

@sherine-k sherine-k

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@jpower432 @soltysh @sherine-k @jharmison-redhat @openshift-merge-robot