search

opendatahub-io / ai-edge

ODH integration with AI at the Edge usecases
Apache License 2.0
9 stars 18 forks source link

RHOAIENG-1910: Rework the documentation to be more consistent #221

Closed devguyio closed 6 months ago

devguyio commented 6 months ago

[!NOTE] This PR is a reopened PR from #213

Description

While trying to set up the environment from scratch I realized our documentation has become incoherent and difficult to follow without having a previous understanding of the PoC.

So I reworked the docs to try and reach a more coherent flow of documentation that can also work for both setting up the edge clusters in the cloud or locally using OpenShift Local.

You can view the rendered version on the branch directly.

How Has This Been Tested?

Merge criteria:

openshift-ci-robot commented 6 months ago

@devguyio: This pull request references RHOAIENG-1910 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.16.0" version, but no target version was set.

In response to [this](https://github.com/opendatahub-io/ai-edge/pull/221): > > >## Description > >_This PR is a reopened PR from #213 _ >While trying to set up the environment from scratch I realized our documentation has become incoherent and difficult to follow without having a previous understanding of the PoC. > >So I reworked the docs to try and reach a more coherent flow of documentation that can also work for both setting up the edge clusters in the cloud or locally using OpenShift Local. > >You can view the rendered version [on the branch directly](https://github.com/devguyio/ai-edge/tree/dev-env). > >## How Has This Been Tested? > > > > >## Merge criteria: > > > >- [ ] The commits are squashed in a cohesive manner and have meaningful messages. >- [ ] Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious). >- [ ] 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[bot] commented 6 months ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: devguyio

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)~~ [devguyio] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
openshift-ci-robot commented 6 months ago

@devguyio: This pull request references RHOAIENG-1910 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.16.0" version, but no target version was set.

In response to [this](https://github.com/opendatahub-io/ai-edge/pull/221): > > >## Description > >_This PR is a reopened PR from #213 _ >While trying to set up the environment from scratch I realized our documentation has become incoherent and difficult to follow without having a previous understanding of the PoC. > >So I reworked the docs to try and reach a more coherent flow of documentation that can also work for both setting up the edge clusters in the cloud or locally using OpenShift Local. > >You can view the rendered version [on the branch directly](https://github.com/devguyio/ai-edge/tree/dev-env). > >## How Has This Been Tested? > > > > >## Merge criteria: > > > >- [x] The commits are squashed in a cohesive manner and have meaningful messages. >- [ ] Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious). >- [ ] 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 6 months ago

@devguyio: This pull request references RHOAIENG-1910 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.16.0" version, but no target version was set.

In response to [this](https://github.com/opendatahub-io/ai-edge/pull/221): > > >## Description > >_This PR is a reopened PR from #213 _ >While trying to set up the environment from scratch I realized our documentation has become incoherent and difficult to follow without having a previous understanding of the PoC. > >So I reworked the docs to try and reach a more coherent flow of documentation that can also work for both setting up the edge clusters in the cloud or locally using OpenShift Local. > >You can view the rendered version [on the branch directly](https://github.com/devguyio/ai-edge/tree/dev-env). > >## 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.
grdryn commented 6 months ago

I think the other PR should be usable again, so going to try closing this so that I can reopen the other one again.

grdryn commented 6 months ago

It seems the other one can't be re-opened because the branch was either force-pushed or recreated while closed. No worries.

openshift-ci-robot commented 6 months ago

@devguyio: This pull request references RHOAIENG-1910 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.16.0" version, but no target version was set.

In response to [this](https://github.com/opendatahub-io/ai-edge/pull/221): > > >## Description > >_This PR is a reopened PR from #213 _ >While trying to set up the environment from scratch I realized our documentation has become incoherent and difficult to follow without having a previous understanding of the PoC. > >So I reworked the docs to try and reach a more coherent flow of documentation that can also work for both setting up the edge clusters in the cloud or locally using OpenShift Local. > >You can view the rendered version [on the branch directly](https://github.com/devguyio/ai-edge/tree/dev-env). > >## 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 6 months ago

@devguyio: This pull request references RHOAIENG-1910 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.16.0" version, but no target version was set.

In response to [this](https://github.com/opendatahub-io/ai-edge/pull/221): > > >## Description > > >_This PR is a reopened PR from #213_ > >While trying to set up the environment from scratch I realized our documentation has become incoherent and difficult to follow without having a previous understanding of the PoC. > >So I reworked the docs to try and reach a more coherent flow of documentation that can also work for both setting up the edge clusters in the cloud or locally using OpenShift Local. > >You can view the rendered version [on the branch directly](https://github.com/devguyio/ai-edge/tree/dev-env). > >## 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 6 months ago

@devguyio: This pull request references RHOAIENG-1910 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.16.0" version, but no target version was set.

In response to [this](https://github.com/opendatahub-io/ai-edge/pull/221): > > >## Description > >> [!NOTE] >> This PR is a reopened PR from #213 > >While trying to set up the environment from scratch I realized our documentation has become incoherent and difficult to follow without having a previous understanding of the PoC. > >So I reworked the docs to try and reach a more coherent flow of documentation that can also work for both setting up the edge clusters in the cloud or locally using OpenShift Local. > >You can view the rendered version [on the branch directly](https://github.com/devguyio/ai-edge/tree/dev-env). > >## 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.
grdryn commented 6 months ago

/lgtm

grdryn commented 6 months ago

/retest