Focus README.md on swap development mode #909
Conversation
Codecov Report
@@ Coverage Diff @@
## master #909 +/- ##
=======================================
Coverage 33.36% 33.37%
=======================================
Files 67 67
Lines 5380 5379 -1
=======================================
Hits 1795 1795
+ Misses 3436 3435 -1
Partials 149 149
Continue to review full report at Codecov.
|
pchico83
force-pushed
the
init
branch
2 times, most recently
from
060a527
to
f0ccaf1
Compare
README.md
Outdated
|
|
||
| Okteto supports applications with one or with multiple services. | ||
| - Keep files synchronized both ways between your laptop and your deployment. |
There was a problem hiding this comment.
This list is not consistent with the previous paragraph, since this are not "things you can define" but rather actions okteto up performs for you
README.md
Outdated
|
|
||
| Okteto detects your code changes and synchronizes your code to your development environment (powered by [Syncthing](https://github.com/syncthing/syncthing)). Files are synchronized both ways. If you edit a file directly in your development environment, the changes will be reflected locally as well. Great for keeping your `package-lock.json` or `requirements.txt` up to date. | ||
| Okteto developer mode has several adantages versus tradicional development: | ||
| - Relaunch your application from your development container with your latest code changes. Native builds are always faster than the *docker build/redeploy* cycle. |
There was a problem hiding this comment.
What is this? We don't talk about developer container at all on the readme. I think it's a good concept but we should then introduce it earlier on and explain what are we talking about.
README.md
Outdated
| Okteto developer mode has several adantages versus tradicional development: | ||
| - Relaunch your application from your development container with your latest code changes. Native builds are always faster than the *docker build/redeploy* cycle. | ||
| - Eliminate integration issues. Your development container reuses the same variables, secrets, sidecards, volumes... than your original Kubernetes deployment. | ||
| - Hardware and network just limited by the power of your cluster. |
README.md
Outdated
| - Eliminate integration issues. Your development container reuses the same variables, secrets, sidecards, volumes... than your original Kubernetes deployment. | ||
| - Hardware and network just limited by the power of your cluster. | ||
|
|
||
| Okteto supports applications with one or with multiple services. If your okteto manifest does not match a running deployment, a new deployment is created on the fly. |
There was a problem hiding this comment.
I'd remove this paragraph, I think it just confuses.
README.md
Outdated
| - Run `okteto up` to launch your development environment in seconds. | ||
|
|
||
| Add `okteto.yml` to your repo and make collaboration easier than ever. Clone the repository and simply run `okteto up` to launch a fully configured development environment. | ||
|
|
||
| ### Developer Mode |
There was a problem hiding this comment.
maybe we should start with the diagram and talking about how okteto up swaps a piece of your application with your developer container. And then get the rest of things that happen (file sync, port forwards, SSH server, etc...)
|
Thank you for your contribution. I've just checked and your commit doesn't appear to be signed-off. That's something we need before your Pull Request can be merged. Please see our contributing guide. |
pchico83
force-pushed
the
init
branch
4 times, most recently
from
245c13a
to
5df78ff
Compare
|
|
||
| You can also directly download the precompiled binary from [the releases page](https://github.com/okteto/okteto/releases). | ||
|  |
There was a problem hiding this comment.
maybe I can update the diagram to use the concepts of "development container" in it, and make some other improvements
There was a problem hiding this comment.
That would be cool. I am going to merge it, but if you can, update the image later.
README.md
Outdated
|
|
||
| Okteto easily integrates and augments your existing tools. You write code locally, which means Okteto is compatible with any IDE. And you can configure your own development environment runtime using a docker image, with your own compilers, linters, debuggers or hot reloaders. | ||
| All you need to get started is to [install the Okteto CLI](https://okteto.com/docs/getting-started/installation/index.html) and have access to a Kubernetes cluster. You can also use Okteto in [Okteto Cloud](https://okteto.com/), the best development platform for Kubernetes applications. |
There was a problem hiding this comment.
the best development platform for Kubernetes applications, I know this was already there but it still sounds odd to me. Maybe something like our hosted development platform for Kubernetes applications or our approach to a hosted development platform for Kubernetes applications on top of Okteto.
There was a problem hiding this comment.
I think it's better to remove that last sentence.
Signed-off-by: Pablo Chico de Guzman <pchico83@gmail.com>
Signed-off-by: Ramiro Berrelleza <rberrelleza@gmail.com>
Signed-off-by: Pablo Chico de Guzman <pchico83@gmail.com>
Also, add a more visual explanation for the concept of developing in a container