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

How-tos document to help user to understand how to use devfile in different scenarios #380

Closed
elsony opened this issue Mar 18, 2021 · 1 comment · Fixed by devfile/docs#119
Closed

How-tos document to help user to understand how to use devfile in different scenarios #380

elsony opened this issue Mar 18, 2021 · 1 comment · Fixed by devfile/docs#119
Labels
area/documentation Improvements or additions to documentation help wanted Extra attention is needed kind/enhancement New feature or request severity/P2 Issues that have a major impact

Comments

@elsony
Copy link
Contributor

elsony commented Mar 18, 2021

Add a how-tos section in documentation to help users to provide concrete examples to users on how to use devfiles (we can consider having separate how-tos section in each persona or group them together). For each how-to, it needs to provide examples of devfile with the explanation on each section of the devfile.

Some examples of how-to topics include:

  1. Simple sample to complex example with steps/pointers/explanation
  2. Adding a database
  3. Adding a new component to my application
@elsony elsony added the area/documentation Improvements or additions to documentation label Mar 18, 2021
@rkratky
Copy link
Collaborator

rkratky commented Mar 25, 2021

JIRA: https://issues.redhat.com/browse/RHDEVDOCS-2869

@rkratky rkratky added help wanted Extra attention is needed kind/enhancement New feature or request severity/P2 Issues that have a major impact labels Mar 25, 2021
@jc-berger jc-berger mentioned this issue Mar 31, 2021
Closed
@jc-berger jc-berger mentioned this issue Jan 5, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/documentation Improvements or additions to documentation help wanted Extra attention is needed kind/enhancement New feature or request severity/P2 Issues that have a major impact
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

added doc for how to develop with devfiles
2 participants
@rkratky @elsony