RHOAIENG-207: Document the user information required for any Pipeline execution path

jackdelahunt commented 2 months ago

Description

As we build out the Pipeline to support we need to have all of these configuration options documented so that there is a source of truth for what is required to execute any pipeline.

This PR gives more detailed docs and a README. I generated the READMEs based on the tasks from this

How Has This Been Tested?

Merge criteria:

[x] The commits are squashed in a cohesive manner and have meaningful messages.
[x] Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
[x] The developer has manually tested the changes and verified that the changes work

openshift-ci-robot commented 2 months ago

@jackdelahunt: This pull request references RHOAIENG-207 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.18.0" version, but no target version was set.

In response to [this](https://github.com/opendatahub-io/ai-edge/pull/289): > > >## Description >As we build out the Pipeline to support fetch a pre-trained Tensorflow|Openvino from S3|Git|..., and pushing it to an cloud|on-prem image registry, we need to have all of these configuration options documented so that there is a source of truth for what is required to execute any pipeline. > >## How Has This Been Tested? > > > > >## Merge criteria: > > > >- [x] The commits are squashed in a cohesive manner and have meaningful messages. >- [x] Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious). >- [x] The developer has manually tested the changes and verified that the changes work > Instructions for interacting with me using PR comments are available [here](https://prow.ci.openshift.org/command-help?repo=opendatahub-io%2Fai-edge). If you have questions or suggestions related to my behavior, please file an issue against the [openshift-eng/jira-lifecycle-plugin](https://github.com/openshift-eng/jira-lifecycle-plugin/issues/new) repository.

openshift-ci-robot commented 2 months ago

@jackdelahunt: This pull request references RHOAIENG-207 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.18.0" version, but no target version was set.

In response to [this](https://github.com/opendatahub-io/ai-edge/pull/289): > > >## Description >As we build out the Pipeline to support we need to have all of these configuration options documented so that there is a source of truth for what is required to execute any pipeline. > >This PR gives more detailed docs and a README. Currently I have the README in `tasks/docs/[task.name]/README.md` this can be changed on what we want. I generated the READMEs based on the tasks from [this](https://github.com/jackdelahunt/taskmd) > >## How Has This Been Tested? > > > > >## Merge criteria: > > > >- [x] The commits are squashed in a cohesive manner and have meaningful messages. >- [x] Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious). >- [x] The developer has manually tested the changes and verified that the changes work > Instructions for interacting with me using PR comments are available [here](https://prow.ci.openshift.org/command-help?repo=opendatahub-io%2Fai-edge). If you have questions or suggestions related to my behavior, please file an issue against the [openshift-eng/jira-lifecycle-plugin](https://github.com/openshift-eng/jira-lifecycle-plugin/issues/new) repository.

openshift-ci-robot commented 2 months ago

@jackdelahunt: This pull request references RHOAIENG-207 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.18.0" version, but no target version was set.

In response to [this](https://github.com/opendatahub-io/ai-edge/pull/289): > > >## Description >As we build out the Pipeline to support we need to have all of these configuration options documented so that there is a source of truth for what is required to execute any pipeline. > >This PR gives more detailed docs and a README. I generated the READMEs based on the tasks from [this](https://github.com/jackdelahunt/taskmd) > >## How Has This Been Tested? > > > > >## Merge criteria: > > > >- [x] The commits are squashed in a cohesive manner and have meaningful messages. >- [x] Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious). >- [x] The developer has manually tested the changes and verified that the changes work > Instructions for interacting with me using PR comments are available [here](https://prow.ci.openshift.org/command-help?repo=opendatahub-io%2Fai-edge). If you have questions or suggestions related to my behavior, please file an issue against the [openshift-eng/jira-lifecycle-plugin](https://github.com/openshift-eng/jira-lifecycle-plugin/issues/new) repository.

MarianMacik commented 2 months ago

/retest

MarianMacik commented 2 months ago

/retest

MarianMacik commented 2 months ago

/retest

openshift-ci[bot] commented 2 months ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: MarianMacik

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: - ~~[OWNERS](https://github.com/opendatahub-io/ai-edge/blob/main/OWNERS)~~ [MarianMacik] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment

biswassri commented 2 months ago

/lgtm

Looks good to me too!

opendatahub-io / ai-edge