Add devfile and community documentation to /public #3045
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
cdrage
force-pushed
the
add-new-docs
branch
6 times, most recently
from
89fe023 to
861083a
Compare
|
@boczkowska can you please take a look at this? |
|
|
||
| What is a devfile? | ||
|
|
||
| A https://redhat-developer.github.io/devfile/[devfile] is a portable file that describes your initial development environment. It allows for a _portable_ developmental environment without the need of reconfiguration. |
There was a problem hiding this comment.
do we want to use the word initial? Because that might imply that devfiles do not get updated through out the process of development and behave like a starter kit?
| * A list of pre-defined commands that can be ran | ||
| * Projects to initially clone | ||
|
|
||
| Odo takes these devfile's and transforms them into a workspace of multiple containers running on OpenShift or Docker. |
There was a problem hiding this comment.
Should we exaustively mention Openshift, Kubernetes or Docker?
|
|
||
| Odo takes these devfile's and transforms them into a workspace of multiple containers running on OpenShift or Docker. | ||
|
|
||
| Devfile's are YAML files with a defined definition, take a look at the general https://github.com/redhat-developer/devfile/blob/master/docs/devfile.md[schema] of devfile. |
There was a problem hiding this comment.
defined definition doesn't sound right? maybe defined structure?
| + | ||
| When odo deploys a devfile component, it pulls the images for each `dockercontainer` in `devfile.yaml` and deploys them. | ||
| + | ||
| Each docker container that is deployed is labeled with the name of the odo component, linking all of them together. |
There was a problem hiding this comment.
assuming here the linking all of them together is metaphorical linking and not literal odo link? this might confuse some people?
**What type of PR is this?** > Uncomment only one ` /kind` line, and delete the rest. > For example, `> /kind bug` would simply become: `/kind bug` /kind documentation [skip ci] **What does does this PR do / why we need it**: This moves the "upstream" documentation that we have here: https://github.com/openshift/odo/tree/gh-pages/chosen-docs/upstream to our main `master` branch to we have one central place for documentation changes. **Which issue(s) this PR fixes**: N/A **How to test changes / Special notes to the reviewer**: N/A Signed-off-by: Charlie Drage <charlie@charliedrage.com>
|
I'm going to merge this in for now in order for @GeekArthur to push further changes to the devfile documentation. Also because the doc team is a bit busy at the moment. If @boczkowska or @Preeticp could have a look at this at a later date, that'd be great. But as of right now, let's merge so we can push further changes / updates to the site with no blockers. |
What type of PR is this?
/kind documentation
[skip ci]
What does does this PR do / why we need it:
This moves the "upstream" documentation that we have here:
https://github.com/openshift/odo/tree/gh-pages/chosen-docs/upstream to
our main
masterbranch to we have one central place for documentationchanges.
Which issue(s) this PR fixes:
N/A
How to test changes / Special notes to the reviewer:
N/A
Signed-off-by: Charlie Drage charlie@charliedrage.com