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

Unexpected mention of 'crc' in 'kubernetes prerequisites' #4113

Closed
cfergeau opened this issue Oct 12, 2020 · 0 comments · Fixed by #4133
Closed

Unexpected mention of 'crc' in 'kubernetes prerequisites' #4113

cfergeau opened this issue Oct 12, 2020 · 0 comments · Fixed by #4133
Assignees
@dharmit

Comments

@cfergeau
Copy link

/kind documentation

What mistake did you find / what is missing in the documentation?

Reading https://github.com/openshift/odo/blob/master/docs/public/deploying-a-devfile-using-odo.adoc I see:

for Minikube or CRC clusters running in a virtual machine you can get it by minikube ip or crc ip

under Prerequisites for a Kubernetes Cluster

crc provides an OpenShift cluster, so I don't understand why it's mentioned under Kubernetes clusters rather than in the previous section which is about Prerequisites for an OpenShift Cluster?
It's also better to use the full name CodeReady Containers (crc)
@dharmit dharmit self-assigned this Oct 12, 2020
cdrage added a commit to cdrage/odo that referenced this issue Oct 22, 2020
@cdrage
Update deploying a devfile documentation
b8de219 
**What type of PR is this?**
> Uncomment only one ` /kind` line, and delete the rest.
> For example, `> /kind bug` would simply become: `/kind bug`

/kind documentation
[skip ci]

**What does does this PR do / why we need it**:

- Updates the documentation regarding deploying a devfile
- Changes the wording to include Kubernetes first and then OpenShift.
- Moves the tutorial / prerequisites around so Kubernetes is first
- Removes the part regarding CRC and adds it to the OpenShift
prerequisites and the same for Kubernetes with Minishift.

**Which issue(s) this PR fixes**:

redhat-developer#4113

**PR acceptance criteria**:

- [X] Documentation

- [X] I have read the [test guidelines](https://github.com/openshift/odo/blob/master/docs/dev/test-architecture.adoc)

**How to test changes / Special notes to the reviewer**:

N/A

Signed-off-by: Charlie Drage <charlie@charliedrage.com>
@cdrage cdrage mentioned this issue Oct 22, 2020
Merged
2 tasks
openshift-merge-robot pushed a commit that referenced this issue Oct 24, 2020
@cdrage
Update deploying a devfile documentation (#4133)
8e14547 
**What type of PR is this?**
> Uncomment only one ` /kind` line, and delete the rest.
> For example, `> /kind bug` would simply become: `/kind bug`

/kind documentation
[skip ci]

**What does does this PR do / why we need it**:

- Updates the documentation regarding deploying a devfile
- Changes the wording to include Kubernetes first and then OpenShift.
- Moves the tutorial / prerequisites around so Kubernetes is first
- Removes the part regarding CRC and adds it to the OpenShift
prerequisites and the same for Kubernetes with Minishift.

**Which issue(s) this PR fixes**:

#4113

**PR acceptance criteria**:

- [X] Documentation

- [X] I have read the [test guidelines](https://github.com/openshift/odo/blob/master/docs/dev/test-architecture.adoc)

**How to test changes / Special notes to the reviewer**:

N/A

Signed-off-by: Charlie Drage <charlie@charliedrage.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dharmit dharmit

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update deploying a devfile documentation cdrage/odo
3 participants
@cfergeau @dharmit @openshift-ci-robot