-
Notifications
You must be signed in to change notification settings - Fork 74
Closed
devfile/docs
#79Labels
area/documentationImprovements or additions to documentationImprovements or additions to documentationhelp wantedExtra attention is neededExtra attention is neededkind/enhancementNew feature or requestNew feature or requestseverity/P2Issues that have a major impactIssues that have a major impactstudentIdentified work that the students can work onIdentified work that the students can work on
Description
The existing documentation is more spec-focused. We need a landing page that helps to promote devfile and let the user buy-in to adopt devfiles and use them in their day-to-day development.
The landing page will answer the following questions:
- What is devfile?
- What is the existing problem that different persona is facing, e.g. application developer, runtime providers, architect?
- Benefits of devfile
- How does it fit into the full development cycle, e.g. local, then container, then k8s, inner-loop to outer-loop, etc.
Then, the landing page will branch off to 4 main personas and provide the information targeted for each of them with samples and best practices:
- application developer
- runtime providers
- registry admin
- tools provider
Note: example of best practices include (depending on the persona):
- How to limit resources
- What are the things I should put in my devfiles
- What are the things I should not put in my devfiles
- How to work with devfiles along with application development’s lifecycle
Metadata
Metadata
Assignees
Labels
area/documentationImprovements or additions to documentationImprovements or additions to documentationhelp wantedExtra attention is neededExtra attention is neededkind/enhancementNew feature or requestNew feature or requestseverity/P2Issues that have a major impactIssues that have a major impactstudentIdentified work that the students can work onIdentified work that the students can work on