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

Content taken from Eclipse Che: Irrelevant to Devfiles #491

Closed
jc-berger opened this issue Jun 11, 2021 · 1 comment · Fixed by devfile/docs#77
Closed

Content taken from Eclipse Che: Irrelevant to Devfiles #491

jc-berger opened this issue Jun 11, 2021 · 1 comment · Fixed by devfile/docs#77
Assignees
Labels
area/documentation Improvements or additions to documentation

Comments

@jc-berger
Copy link

jc-berger commented Jun 11, 2021

Content from Eclipse Che might be irrelevant for devfiles
The following docs were adapted from Eclipse Che, and therefore, some large chunks of content might not pertain to devfiles or might need serious revisions in order to make sense in context of devfiles:

  1. Determine the role endpoints and ports have in devfiles. This doc was very focused on Che UI and devfiles have no UI. Lines 5, 62, and 74 were Che UI focused. Verify that the edited versions still make sense and add meaning to the content.
  1. Line 11. The original talked about Che workspaces. Devfiles don't have workspaces so confirm if the current content is till relevant.
  2. Lines 24 and 36, prod-short initially referred to Che. So we can't simply replace it with "devfiles." Check these sections and the entire doc to make sure the use of "devfiles" still make sense.
  1. Lines 81: verify if we can use "devfiles" here. We probably can't substitute "Che" with "devfiles" and have it make sense. Also, verify that the example is still relevant. Does devfiles even have a "sleep command" and "infinity argument"?
  1. Line 37. For the subheading, we say "Parent referred by a URI" But the example uses a URL. If we use URIs, we might need a different example.

Additional context
See the conversations and commit history in the following doc PRS for more details on specific areas of content that were taken from Eclipse Che.

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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant