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.

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

Devfile how-to documentation #424

Closed
rtaniwa opened this issue Apr 23, 2021 · 1 comment
Closed

Devfile how-to documentation #424

rtaniwa opened this issue Apr 23, 2021 · 1 comment
Labels
area/documentation Improvements or additions to documentation kind/enhancement New feature or request

Comments

@rtaniwa
Copy link

rtaniwa commented Apr 23, 2021

Problem:
Right now, we are missing a guided How-to for how to author a devfile.

Goal:
Provide a how-to documentation which walk a reader (and developer) into each of the steps that are needed in order to get a devfile for from a simple project, to something a bit more advanced.

We need to look at different scenarios (not exhaustive):

  • My source code exist, how do I get started?
    • From existing stack's devfile
    • What if there is not a suitable devfile for my project
  • How to add different services
    • Database
    • Tools
    • New component
  • How to configure it for Build, Run and Debug?
  • Speak about the tools that can use devfile.

Why is it important?
This How-tos should help users and customers to get start with devfile. They should learn how they can create the devfile for their own project. Today, devfile are mostly used for getting started and we want more project leveraging it (along with the tools that can leverage it)

@rtaniwa rtaniwa added area/documentation Improvements or additions to documentation kind/enhancement New feature or request labels Apr 23, 2021
@Jdubrick
Copy link
Contributor

Jdubrick commented Mar 5, 2024

I believe a combination of docs from https://devfile.io/docs/2.2.2/authoring-overview and https://devfile.io/docs/2.2.2/adding-components could be used to achieve a how-to instruction.

@Jdubrick Jdubrick closed this as completed Mar 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation kind/enhancement New feature or request
Projects
Status: Done ✅
Development

No branches or pull requests

2 participants