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

Introduce CONTRIBUTING.md file. #41

Merged
merged 4 commits into from
Aug 8, 2019
Merged

Conversation

AndrienkoAleksandr
Copy link
Contributor

@AndrienkoAleksandr AndrienkoAleksandr commented Aug 7, 2019

Referenced issue:

eclipse-che/che#14126

Introduce CONTRIBUTING.md file.

Signed-off-by: oandriie@redhat.com <oandriie@redhat.com>
Signed-off-by: oandriie@redhat.com <oandriie@redhat.com>
CONTRIBUTION.md Outdated
### Recommended development flow

The most natural way to develop che-machine-exec it's using Eclipse CHE workspace.
To install Eclipse CHE you need to choose infrastructure(openshift, kubernetes or docker) and set up it.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that we not support docker as platform now

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe provide links to https://www.eclipse.org/che/docs/che-7/che-quick-starts.html#running-che-locally_che-quick-starts (how to install Che)
Eclipse CHE --> Eclipse Che

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that we not support docker as platform now

maybe provide links to https://www.eclipse.org/che/docs/che-7/che-quick-starts.html#running-che-locally_che-quick-starts (how to install Che)
Eclipse CHE --> Eclipse Che

Done

Copy link

@l0rd l0rd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you probably mean CONTRIBUTING not CONTRIBUTION as we have in other repositories https://github.com/eclipse/che/blob/master/CONTRIBUTING.md

CONTRIBUTION.md Outdated Show resolved Hide resolved
CONTRIBUTION.md Outdated

### Create Eclipse CHE workspace from devfile

To start Eclipse CHE workspace, install the latest [chectl](https://github.com/che-incubator/chectl/releases) and start new workspace from devfile:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would like to mention how to do that from dashboard as well.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

@AndrienkoAleksandr AndrienkoAleksandr Aug 7, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

preferable to link to https://www.eclipse.org/che/docs/che-7/che-quick-starts.html#running-che-locally_che-quick-starts (so that repo can change, etc)

Done.

I would like to mention how to do that from dashboard as well.

I don't mind, but as for me current dashboard flow looks strange. To create new workspace from devfile using dashboard I need to create new workspace from some random devfile and than replace content by che-machine-exec devfile. Looks like we missed up dashboard feature to simplify this flow.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not necessarily. One may use factory link

@sunix
Copy link
Contributor

sunix commented Aug 7, 2019

In general it looks very nice (even though i have not tried it, but I will try eventually :) ). Good work.

@AndrienkoAleksandr AndrienkoAleksandr changed the title Introduce CONTRIBUTION.md file. Introduce CONTRIBUTING.md.md file. Aug 7, 2019
@AndrienkoAleksandr AndrienkoAleksandr changed the title Introduce CONTRIBUTING.md.md file. Introduce CONTRIBUTING.md file. Aug 7, 2019
Signed-off-by: oandriie@redhat.com <oandriie@redhat.com>
Signed-off-by: oandriie@redhat.com <oandriie@redhat.com>
@AndrienkoAleksandr AndrienkoAleksandr merged commit 9c264be into master Aug 8, 2019
@AndrienkoAleksandr AndrienkoAleksandr deleted the CONTRIBUTION_MD branch August 8, 2019 09:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants