search

devfile / api

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

Devfile Tutorial For Various Personas #454

Open maysunfaisal opened 3 years ago

maysunfaisal commented 3 years ago

Background

This issue discusses the need for a devfile tutorial from different perspectives for the various personas. For example, we would like to have tutorials for Application Developers, Devfile authors/Stack providers, Registry Administrators, Devfile Consumers, etc.

We would like to showcase the various functionalities of the Devfile when curating tutorials for these personas and how to try devfiles out before diving in(Maybe point them towards Developer Sandbox, as we can spin up a OpenShift cluster and they can try out devfiles on ODC).

Work

When working on these tutorials, we can leverage the devfile v2 documentation that we have and also update them as we see fit. We can craft slides, demos, samples, etc to reach our objectives.

These tutorials can be hosted on Red Hat’s website, devfile’s documentation and can be used for conferences in the future.

ghost commented 2 years ago

Hi @maysunfaisal this issue looks interesting..I'd love to work on it :)

maysunfaisal commented 2 years ago

@yimikao that sounds awesome

We will update the issue with specifics, so you can work on this

maysunfaisal commented 1 year ago

After having some discussion with the team, we realized that the approach we would like to take in this issue is to create a guide for the Application Developers persona.

In this proposed guide, we could elaborate on how to incorporate a devfile into an application/project. For instance, we could write up about how as an application developer, one would get their application running with a devfile workspace definition. We could leverage tools like odo to test out the devfile and perhaps incorporate the example of using odo in our guide.

This python devfile sample could be used as an example if the guide is aimed towards creating devfile sample repositories.

For devfile stack (which is different from devfile samples), there is an issue https://github.com/devfile/api/issues/911 which is mostly geared towards it. When https://github.com/devfile/api/issues/911 is complete, we could potentially leverage that guide/documentation in our guide to say how to author a devfile from scratch.

We should also leverage the documentation on devfile.io to refer information.

maysunfaisal commented 1 year ago

@yimikao sorry for the delay in hashing this issue out. But I've posted some details on how to get started. Are you still interested in picking this up? If so, please assign yourself and I can get it tracked.

github-actions[bot] commented 1 month 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.