odo icon indicating copy to clipboard operation
odo copied to clipboard

Add tutorials under "Using odo" section to docusaurus based site

Open dharmit opened this issue 4 years ago • 2 comments

/kind documentation /kind task

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

This is a child issue of spawned from https://github.com/openshift/odo/issues/4664#issuecomment-875511836.

What is the relevance of it?

"Using odo" section needs to be an end-to-end story where a user can follow every guide in a sequential order and achieve results using odo; OR they can pick up any guide from the middle and still be able to understand and follow the steps as long as they have followed the earlier guides in the sequence.

We will use odo quickstart project across these guides.

Acceptance Criteria

Sprint 206

  • [ ] Environment Variables
  • [ ] Continuous Development using odo watch
  • [ ] Create URL to access the project
  • [ ] Create and Link Services

Sprint 205

  • [x] Create a component and push it (#4982)
  • [ ] Environment Variables
  • [ ] Continuous Development using odo watch
  • [ ] Create URL to access the project
  • [ ] Create and Link Services
All these to be shown for both k8s (using minikube) and OCP (using CRC) clusters.

Past Acceptance Criteria

Sprint 204

NOTE: we might need to add something in the below sequence, or need to change order; it's not 100% complete or accurate.

  • [ ] Create Component
  • [ ] Environment Variables
  • [ ] Continuous Development
  • [ ] Create URL
  • [ ] Debug Applications
  • [ ] Lifecycle Events
  • [ ] Persistent Storage
  • [ ] Push Specific Files
  • [ ] Create and Link Services

dharmit avatar Jul 08 '21 10:07 dharmit

"Using odo" section needs to be an end-to-end story where a user can follow every guide in a sequential order and achieve results using odo; OR they can pick up any guide from the middle and still be able to understand and follow the steps as long as they have followed the earlier guides in the sequence.

One more thing that we could aim for is to give the reader a way to pull a devfile.yaml in every tutorial. This devfile.yaml will help user set things up till the previous guide in the flow.

dharmit avatar Jul 08 '21 10:07 dharmit

Unassinging myself since it's mostly Charlie carrying this effort forward.

/unassign @dharmit

dharmit avatar Jun 20 '22 07:06 dharmit

/close I think we have got this covered. Feel free to reopen if you think otherwise.

valaparthvi avatar Oct 13 '22 11:10 valaparthvi

@valaparthvi: Closing this issue.

In response to this:

/close I think we have got this covered. Feel free to reopen if you think otherwise.

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.

openshift-ci[bot] avatar Oct 13 '22 11:10 openshift-ci[bot]