devfile / api

Kube-native API for cloud development workspaces specification
Apache License 2.0
253 stars 60 forks source link

Documentation changes with the new user in mind #1080

Open michael-valdron opened 1 year ago

michael-valdron commented 1 year ago

/kind user-story /kind epic

Which area this user story is related to?

/area documentation

User Story

As a new user to devfiles, I would like to see documentation which gives the a clear practical introduction to setting up the spec for my development environment, so that I obtain the understanding needed to continue using devfiles and the supporting developer tools as my choice for developing Kubernetes applications and services.

To meet these requirements, additions and revisions to our doc pages are needed to create a new user friendly experience.

Acceptance Criteria

michael-valdron commented 1 year ago

Good part of this should close https://github.com/devfile/api/issues/424.

michael-valdron commented 1 year ago

Adding #885 to this epic due to it being a blocker to the epic item #886.

michael-valdron commented 1 year ago

This epic is out of sprint so I will move this into backlog.

github-actions[bot] commented 10 months ago

This issue is stale because it has been open for 90 days with no activity. Remove stale label or comment or this will be closed in 60 days.