From cfa2320cb351b5fb2ca66bf6855bbe1c3fe7ada3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Hohwiller?= Date: Thu, 22 Jul 2021 17:37:59 +0200 Subject: [PATCH] #584: marked as experimental, updated docs (#595) --- CHANGELOG.asciidoc | 13 +++++++++++++ documentation/LICENSE.asciidoc | 4 ++++ documentation/docker.asciidoc | 8 ++++++++ documentation/features.asciidoc | 4 ++-- documentation/kubectl.asciidoc | 7 +++++++ documentation/setup.asciidoc | 4 ++-- documentation/usage.asciidoc | 17 ++++++++--------- 7 files changed, 44 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.asciidoc b/CHANGELOG.asciidoc index ffc8af4f9..1e4b5d873 100644 --- a/CHANGELOG.asciidoc +++ b/CHANGELOG.asciidoc @@ -2,6 +2,19 @@ This file documents all notable changes to https://github.com/devonfw/ide[devonfw-ide]. +== 2021.04.002 + +Update with the following bugfixes and improvements: + +* https://github.com/devonfw/ide/issues/340[#340]: Improve CobiGen CLI with update support +* https://github.com/devonfw/ide/issues/584[#584]: add commandlets for docker and kubernetes (experimental) +* https://github.com/devonfw/ide/issues/591[#591]: Update node.js and related components to fix CVEs +* https://github.com/devonfw/ide/issues/585[#585]: Settings repos with branches +* https://github.com/devonfw/ide/issues/581[#581]: Redundant update sites not updated +* https://github.com/devonfw/ide/pull/589[#589]: Update advanced-tooling-windows.asciidoc + +The full list of changes for this release can be found in https://github.com/devonfw/ide/milestone/20?closed=1[milestone 2021.04.002]. + == 2021.04.001 Update with the following bugfixes and improvements: diff --git a/documentation/LICENSE.asciidoc b/documentation/LICENSE.asciidoc index cd88cd480..85ca73293 100644 --- a/documentation/LICENSE.asciidoc +++ b/documentation/LICENSE.asciidoc @@ -53,6 +53,10 @@ The following table shows the components that may be used. The column `inclusion |https://github.com/devonfw/devon4j[devon4j] |Optional|https://github.com/devonfw/devon4j/blob/develop/LICENSE[ASL 2.0] |https://github.com/devonfw/devon4ng[devon4ng] |Optional|https://github.com/devonfw/devon4ng/blob/master/LICENSE.txt[ASL 2.0] |https://github.com/devonfw/devon4node[devon4node] |Optional|https://github.com/devonfw/devon4node/blob/develop/LICENSE.txt[ASL 2.0] +|https://www.jetbrains.com/idea/[IntelliJ IDEA] |Optional|https://www.jetbrains.com/opensource/idea/[ASL 2.0] +|http://www.jasypt.org/[jasypt] |Optional|http://www.jasypt.org/license.html[ASL 2.0] +|https://www.docker.com/[docker]| Optional|https://docs.docker.com/engine/#licensing[ASL 2.0] and https://www.docker.com/legal/docker-software-end-user-license-agreement[EULA] +|https://kubernetes.io/[kubernetes]| Optional|https://github.com/kubernetes/kubernetes/blob/master/LICENSE[ASL 2.0] |======================= == Apache Software License - Version 2.0 diff --git a/documentation/docker.asciidoc b/documentation/docker.asciidoc index 067ffe5d1..aa78e9a05 100644 --- a/documentation/docker.asciidoc +++ b/documentation/docker.asciidoc @@ -6,6 +6,14 @@ toc::[] The `docker` commandlet allows to install and use https://www.docker.com/[docker]. On Windows https://docs.microsoft.com/en-us/windows/wsl/install-win10[WSL 2](Windows Subsystem for Linux) has to be installed properly as a prerequisite. +*ATTENTION:* +Currently this feature is new and therefore experimental. +It may change in incompatible ways in the next releases until we reach a stable state. +We hope that all is working fine for you. +However, do not expect everything to work out of the box. +In case you are facing issues (e.g. network problems with Cisco AnyConnect, etc.) please give us feedback so we can improve. + + The arguments (`devon docker «args»`) are explained by the following table: .Usage of `devon docker` diff --git a/documentation/features.asciidoc b/documentation/features.asciidoc index 757667015..b5c3be0b1 100644 --- a/documentation/features.asciidoc +++ b/documentation/features.asciidoc @@ -73,7 +73,7 @@ Default locale: en_DE, platform encoding: UTF-8 OS name: "mac os x", version: "10.14.3", arch: "x86_64", family: "mac" [devonfw]$ cd /projects/ide-test/workspaces/test/my-project [my-project]$ devon -devonfw-ide environment variables have been set for /projects/ide-test in workspace main +devonfw-ide environment variables have been set for /projects/ide-test in workspace test [my-project]$ mvn -v Apache Maven 3.6.0 (97c98ec64a1fdfee7767ce5ffb20918da4f719f3; 2018-10-24T20:41:47+02:00) Maven home: /projects/ide-test/software/maven @@ -92,7 +92,7 @@ This was just a very simple demo of what `devonfw-ide` can do. For further detai Now you might ask: -* But I use Windows/Linux/MacOS//… - it works on all platforms! +* But I use Windows/Linux/MacOS/… - it works on all platforms! * But how about Windows CMD or Power-Shell? - it works! * But what if I use cygwin or git-bash on windows? - it works! * But I love to use ConEmu or Commander - it works with full integration! diff --git a/documentation/kubectl.asciidoc b/documentation/kubectl.asciidoc index eb40b6f22..2e7f61781 100644 --- a/documentation/kubectl.asciidoc +++ b/documentation/kubectl.asciidoc @@ -7,6 +7,13 @@ The `kubectl` commandlet allows to install and use https://kubernetes.io/[kubern On Windows https://docs.microsoft.com/en-us/windows/wsl/install-win10[WSL 2](Windows Subsystem for Linux) has to be installed properly as a prerequisite. The setup on windows will then install kubernetes with https://k3d.io[K3D]. K3D will create a cluster with a single node with a default name as "devonfw-cluster" +*ATTENTION:* +Currently this feature is new and therefore experimental. +It may change in incompatible ways in the next releases until we reach a stable state. +We hope that all is working fine for you. +However, do not expect everything to work out of the box. +In case you are facing issues (e.g. network problems with Cisco AnyConnect, etc.) please give us feedback so we can improve. + The arguments (`devon kubectl «args»`) are explained by the following table: .Usage of `devon kubectl` diff --git a/documentation/setup.asciidoc b/documentation/setup.asciidoc index 908fadf12..2b34fbdca 100644 --- a/documentation/setup.asciidoc +++ b/documentation/setup.asciidoc @@ -6,7 +6,7 @@ toc::[] == Prerequisites We try to make it as simple as possible for you. However, there are some minimal prerequisites: -* You need to have a tool to extract `*.tar.gz` files (`tar` and `gzip`). On Windows lower Windows 10 (1803) use https://www.7-zip.org/[7-zip]. On all other platforms this comes out of the box. +* You need to have a tool to extract `*.tar.gz` files (`tar` and `gzip`). On Windows before Version 10 (1803) use https://www.7-zip.org/[7-zip]. On all other platforms this comes out of the box. * You need to have https://git-scm.com[git] and https://curl.haxx.se/[curl] installed. ** On Windows you only need to download and install https://git-scm.com/download/win[git for windows]. This also ships with `bash` and `curl`. ** On Linux you might need to install the above tools in case they are not present (e.g. `sudo apt-get install git curl` or `sudo yum install git-core curl`) @@ -42,5 +42,5 @@ You can therefore find the latest devonfw SNAPSHOT releases https://oss.sonatype Simply choose the latest SNAPSHOT version folder and then inside the `*.tar.gz` file for the latest version. Once downloaded, you can proceed as with official releases (see xref:install[install]). -If your test succeeded with the latest SNAPSHOT please also give confirming feedback to bug or feature tickets to let us know. +If you test the latest SNAPSHOT please also give feedback to bug or feature tickets to let us know if things are working or not. Thanks for your testing, support and help to make devonfw better! diff --git a/documentation/usage.asciidoc b/documentation/usage.asciidoc index cf2eeb508..ddf057a79 100644 --- a/documentation/usage.asciidoc +++ b/documentation/usage.asciidoc @@ -1,13 +1,12 @@ :toc: toc::[] -= Roles +This section explains the usage of `devonfw-ide` according to your role: -This section is designed to explain `devonfw-ide` depending on each role -Everybody should read and follow the usage for xref:developer[developer]. -In case you want to administrate `devonfw-ide` settings for your project, you should also read the usage for the xref:admin[ide-admin]. +* Everybody should read and follow the usage for a xref:developer[developer]. +* In case you want to administrate `devonfw-ide` settings for your project, you should also read the usage for the xref:admin[ide-admin]. -== Developer += Developer As a developer you are supported to link:setup.asciidoc[setup] your IDE automated and fast while you can have a nice cup of coffee (after you provided `settings-URL` and accepted the license). You only need the settings URL from your xref:admin[ide-admin]. Experienced developers can directly call `setup «settings-URL»`. @@ -15,7 +14,7 @@ Otherwise if you just call `setup` (e.g. by double-clicking it), you can enter i Note: devonfw-ide supports autocompletion (since `2021.04.001`). Currently this only works in bash (on windows use git bash). Simply type `devon` and hit `[Tab]` to get completion. -=== Update +== Update To update your IDE (if instructed by your xref:admin[ide-admin]), you only need to run the following command: ``` devon ide update @@ -26,7 +25,7 @@ E.g. if a tool needs to be updated, the old installation folder will be moved to If there are windows file locks in place this can fail and mess up things. You can still delete the according installation from your `software` folder and rerun `devon ide update` if you ran into this error. -=== Working with multiple workspaces +== Working with multiple workspaces If you are working on different branches in parallel you typically want to use multiple workspaces. . Go to the link:workspaces.asciidoc[workspaces] folder in your link:variables.asciidoc[${DEVON_IDE_HOME}] and create a new folder with the name of your choice (e.g. `release2.1`). @@ -35,7 +34,7 @@ If you are working on different branches in parallel you typically want to use m You can have multiple instances of eclipse running for each workspace in parallel. To distinguish these instances you will find the workspace name in the title of eclipse. -== Admin += Admin You can easily customize and link:configuration.asciidoc[configure] `devonfw-ide` for the requirements of your project. In order to do so, you need to create your own project-specific settings git repository and provide the URL to all developers for the link:setup.asciidoc[setup]. @@ -86,7 +85,7 @@ However, when you have done changes especially in a larger project, please consi * If all works as expected, pick a pilot user of the team to test the changes from the feature branch (go to `settings` folder, `git fetch`, `git checkout -t origin/feature/«name»`, `devon ide update`). * Only after that works well for a couple of days, inform the entire team to update. -=== Announce changes to your team +== Announce changes to your team In order to roll out the perfectly configured `devonfw-ide` to your project initially or when new members join, you only have to provide the `Settings URL` to the xref:developer[developers] of your team. You can also provide a specific branch with `Settings URL#branch` to use variations of common settings or to test new settings before making them public to the team.