RHOAIENG-1910: Rework the documentation to be more consistent

devguyio commented 6 months ago

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:

[ ] 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

openshift-ci[bot] commented 6 months ago

Skipping CI for Draft Pull Request. If you want CI signal for your change, please convert it to an actual PR. You can still manually trigger a test run with /test all

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

devguyio commented 6 months ago

/hold

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/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](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.

devguyio commented 6 months ago

Are there any source files for the images that could be included, in case they need to be updated in the future?

The PNG files of the charts already include the metadata of the diagram and can be re-used to update it.

MarianMacik commented 6 months ago

I'm having a look as well.

devguyio commented 6 months ago

/unhold

openshift-merge-robot commented 6 months ago

PR needs rebase.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.

openshift-ci[bot] commented 6 months ago

@devguyio: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/test-ai-edge	9f253797d08f4c7fdd5366d6db8a1aeb150ff7be	link	true	`/test test-ai-edge`

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository. I understand the commands that are listed [here](https://go.k8s.io/bot-commands).

devguyio commented 6 months ago

/retest

devguyio commented 6 months ago

For some reason this PR kept showing that it needs rebase even long after I rebased and pushed. So I had to create another PR (couldn't even reopen this PR after closing it). #221 .

Sorry for the inconvenience.

grdryn commented 6 months ago

/reopen

openshift-ci[bot] commented 6 months ago

@grdryn: Failed to re-open PR: state cannot be changed. There is already an open pull request from devguyio:dev-env to opendatahub-io:main.

In response to [this](https://github.com/opendatahub-io/ai-edge/pull/213#issuecomment-1973377134): >/reopen Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.

grdryn commented 6 months ago

^that was just a test of that command

grdryn commented 6 months ago

@devguyio the issues that you experienced were probably due to the following ongoing GH incident: https://www.githubstatus.com/incidents/wcl1sw4mzg60

grdryn commented 6 months ago

/reopen

openshift-ci[bot] commented 6 months ago

@grdryn: Failed to re-open PR: state cannot be changed. The dev-env branch was force-pushed or recreated.

In response to [this](https://github.com/opendatahub-io/ai-edge/pull/213#issuecomment-1973553305): >/reopen Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.

opendatahub-io / ai-edge