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

Publish Devfile documentation on http://redhat-developer.github.io/devfile #12524

Closed
skabashnyuk opened this issue Jan 27, 2019 · 3 comments
Closed
Assignees
Labels
kind/task Internal things, technical debt, and to-do tasks to be performed.

Comments

@skabashnyuk
Copy link
Contributor

Description

followup of this comment #12272 (comment)
In this issue, we have an experiment with different #12272 ways to generate documentation from devfile json-spec. The goal of the current issue would be: generate documentation and set up a process of publishing this documentation to http://redhat-developer.github.io/devfile

@skabashnyuk skabashnyuk added kind/task Internal things, technical debt, and to-do tasks to be performed. team/platform labels Jan 27, 2019
@mshaposhnik mshaposhnik self-assigned this Jan 29, 2019
@mshaposhnik
Copy link
Contributor

mshaposhnik commented Jan 30, 2019

Here is the first doc version that i build manually after some enhancements in schema: https://github.com/mshaposhnik/mshaposhnik.github.io/blob/master/devfile.md
There is an idea to host it somewhere, until we establish fully authomated build & deploy,
but need to find right place for it. @l0rd do you think that http://redhat-developer.github.io/devfile is the best place for that? Since it is weakly related with Che and it is may be tricky to find it here for users? WDYT?

@l0rd
Copy link
Contributor

l0rd commented Jan 31, 2019

I think the devfile format should be Che agnostic as much as we can. Other projects should use it the same format to define/persist/configure/export their development environment. So it should not be too coupled with eclipse/che.

In eclipse/che we should document how to use a devfile to define a Che workspace. The format description should go in https://redhat-developer.github.io/devfile

@mshaposhnik
Copy link
Contributor

Issue is done, first deployments with Ci job is tested and works OK. Next deployments will be performed on each new tag creation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/task Internal things, technical debt, and to-do tasks to be performed.
Projects
None yet
Development

No branches or pull requests

3 participants