Skip to content

Clarification to specification to ensure consistent tools implementation behaviour #905

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

Closed
elsony opened this issue Aug 3, 2022 · 3 comments · Fixed by devfile/devfile-web#26
Assignees
Labels
area/api Enhancement or issue related to the api/devfile specification area/documentation Improvements or additions to documentation

Comments

@elsony
Copy link
Contributor

elsony commented Aug 3, 2022

/area documentation

Which area this documentation change is related to?
/area api

Issue details

What mistake did you find / what is missing in the documentation?
A couple of areas need to be improved in the documentation to ensure consistent tools implementation behaviour (to address some of the issues defined in #679):

  1. entrypoint of components of type container
    Tools will need to respect the entrypoint settings. If the entrypoint is not defined, use the default from the image. The containers need to be non-terminating or adding commands and args to make it non-terminating. (Provide example e.g. tail to show).

  2. Projects vs starterProjects
    For starterProjects and samples (will just refer to sample in the rest of this item), if a sample contains a devfile, the tools will keep that devfile and use the devfile that is included in the sample. If a devfile does not exist in the sample, the tools will copy the original devfile that contains the starterProjects definition and use that devfile.

Target Date: 09-29-2022

@openshift-ci openshift-ci bot added area/documentation Improvements or additions to documentation area/api Enhancement or issue related to the api/devfile specification labels Aug 3, 2022
@michael-valdron michael-valdron self-assigned this Aug 19, 2022
@michael-valdron
Copy link
Member

michael-valdron commented Aug 22, 2022

Compiled this list of TODOs for this issue (subject to change):

  • Complete 'Container Entrypoint' section of the Adding container component docs page.
  • Add doc page for adding starter projects which mirrors current Adding projects doc page. Migrating projects will still be used for migrating to devfile v2.x.
  • Add documentation on actions tools should take with samples with a devfile versus samples without a devfile.

All these items will contain documentation on respective content described in issue description.

@michael-valdron
Copy link
Member

@elsony @johnmcollier Do we want all changes in this issue to be under all Devfile 2.x versions?

@michael-valdron
Copy link
Member

@elsony @johnmcollier Do we want all changes in this issue to be under all Devfile 2.x versions?

Only placing doc changes under Devfile 2.2.0 as discussed in team meeting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/api Enhancement or issue related to the api/devfile specification area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants