devonfw#41: reworked documentation (devonfw#46)

Author: salimbouch

.mvn/settings.xml

@@ -1,4 +1,3 @@
-
 <?xml version="1.0" encoding="UTF-8"?>
 <settings>
   <servers>

README.adoc

@@ -65,7 +65,7 @@ See also our latest video https://vimeo.com/808368450/88d4af9d18[devon ide updat
 * link:documentation/features.asciidoc[Features]
 * link:documentation/setup.asciidoc[Download & Setup]
 * link:documentation/usage.asciidoc[Usage]
-* link:documentation/devonfw-ide-contribution-getting-started.asciidoc[Contribution]
+* link:documentation/IDEasy-contribution-getting-started.asciidoc[Contribution]
 * link:documentation/configuration.asciidoc[Configuration]
 * link:documentation/structure.asciidoc[Structure]
 * link:documentation/cli.asciidoc[Command Line Interface]

documentation/devonfw-ide-contribution-getting-started.asciidoc documentation/IDEasy-contribution-getting-started.asciidoc

@@ -1,21 +1,21 @@
 :toc:
 toc::[]
 
-= Getting started as developer contributing to devonfw-ide
+= Getting started as developer contributing to IDEasy
 
 == Installation
-To start developing devonfw-ide, you must first install it on your computer.
+To start developing IDEasy, you must first install it on your computer.
 Therefore simply follow the link:setup.asciidoc[setup] guide.
-It is important to notice that this installation gives you the latest published version of the devonfw-ide with which you can execute commands like eclipse or docker whose scripts are located inside the "${DEVON_IDE_HOME}$/scripts/command, but for committing code we use a differing folder structure.
+It is important to notice that this installation gives you the latest published version of IDEasy with which you can execute commands like eclipse or docker whose scripts are located inside the "${IDE_HOME}$/scripts/command, but for committing code we use a differing folder structure.
 This will be addressed under xref:Contribution[Contribution].
 
 == Contribution
 To begin, read through the https://github.com/devonfw/.github/blob/master/CONTRIBUTING.asciidoc[Contribution Guidelines], which you should be sure to follow.
 First steps regarding forks or cloning of repos and creating branches, as well as some git commands, can be found in the https://github.com/firstcontributions/first-contributions[first contributions guideline].
-To contribute code or documentation regarding the devonfw-ide at first you need to fork the https://github.com/devonfw/ide[devonfw-ide] repository and then you can clone your fork into the folder `workspaces/main` in your devonfw-ide installation.
-Open git-bash in the cloned fork at `workspaces/main/ide` and run the following command:
+To contribute code or documentation regarding IDEasy at first you need to fork the https://github.com/devonfw/ideasy[IDEasy] repository and then you can clone your fork into the folder `workspaces/main` in your IDEasy installation.
+Open git-bash in the cloned fork at `workspaces/main/IDEasy` and run the following command:
 ```
-git remote add upstream https://github.com/devonfw/ide.git
+git remote add upstream https://github.com/devonfw/ideasy.git
 git fetch upstream
 ```
 Whenever you want to implement a new change first do the following things:
@@ -27,27 +27,27 @@ git checkout -b feature/«issue-id»-«brief-feature-description»
 ```
 Now you can do the changes, improvements, and fixes.
 Once they are tested and seem to work, you can commit them (`git commit -m "#«issue-id»: «description»"`).
-If some days have passed meanwhile you should merge changes that meanwhile happened on the official `ide` repo:
+If some days have passed meanwhile you should merge changes that meanwhile happened on the official `IDEasy` repo:
 ```
 git pull upstream master
 ```
 Once you are complete and everything is merged and comitted, you can push your local feature branch and make it a remote branch of your fork on github:
 ```
 git push -u origin feature/«issue-id»-«brief-feature-description»
 ```
-Now you can go to https://github.com/devonfw/ide/pulls and create the pull-request (PR) from your new feature.
+Now you can go to https://github.com/devonfw/ideasy/pulls and create the pull-request (PR) from your new feature.
 Therefore, please click on the right down arrow of the green button and choose `Create draft pull request` and then click on `Draft pull request`.
 When the checks have completed you can check the link:DoD.asciidoc[Definition-of-Done] (DoD).
 Once, all checks of the DoD are addressed, you can go the the very bottom of the PR and click on `Ready for review` what will take the PR out of the draft mode.
 FYI: If you forgot the upstream merge (`git pull upstream/master`) or the upstream changed again while your PR is still open, you will see `This branch is out-of-date with the base branch` at the bottom of your PR and can click on `Update branch`.
 
-For further development and testing, it is recommended to xref:symbolic-links[symlink] the modified scripts into your devonfw-ide installation.
+For further development and testing, it is recommended to xref:symbolic-links[symlink] the modified scripts into your IDEasy installation.
 Alternatively, the scripts can be adapted in the installation folder and then committed to the project.
 For creating a contribution also check the link:DoD.asciidoc[Definition of Done] (DoD).
 
 === ShellCheck
 
-To improve the code quality the https://github.com/koalaman/shellcheck/[ShellCheck] is used for devonfw-ide.
+To improve the code quality the https://github.com/koalaman/shellcheck/[ShellCheck] is used for IDEasy.
 There is a GitHub action _CI build PR_ for this. If this fails at the PR, you can find the error messages in the big logfile under _Build project with Maven_.
 For example, these look like this:
 
@@ -109,12 +109,12 @@ The first part of the script contains the autocompletion, which should return th
 Functions like setup or run or other additional functions follow.
 Finally, it defines which function should be executed depending on the parameter.
 
-Use the `doInstall` method for the installation, which downloads the tool based on the mirrors, unpacks it if necessary and puts it in the software folder in the `devonfw-ide` installation:
+Use the `doInstall` method for the installation, which downloads the tool based on the mirrors, unpacks it if necessary and puts it in the software folder in the `IDEasy` installation:
 ```
 doInstall "-" "«installation-folder»" "«tool-name»" "«tool-version»"
 ```
 
-For standard installations omit `"«installation-folder»"` (use the empty string arg `""`) what will install to `${DEVON_IDE_HOME}/software/«tool-name»`.
+For standard installations omit `"«installation-folder»"` (use the empty string arg `""`) what will install to `${IDE_HOME}/software/«tool-name»`.
 
 === LICENSE
 Find the license for the new tool and add the tool to the table of `Third party components` of the link:LICENSE.asciidoc[LICENSE].
@@ -128,17 +128,17 @@ In the configuration files many link:variables.asciidoc[variables] can be define
 
 == Tips and tricks
 
-The following sub-sections give you some tips and tricks to boost your productivity when developing features for `devonfw-ide`.
+The following sub-sections give you some tips and tricks to boost your productivity when developing features for `IDEasy`.
 
 == Symbolic Links
 With link:advanced-tooling-windows.asciidoc##create-symbolic-links[symbolic links] you can use one file or folder that is located inside one directory in one or multiple other directories, without copying the whole file or folder into the other directories.
 The file is still only saved at the initial location, but can be accessed through the  created links in a much more comfortable way.
 So you are actually just linked to the original file and therefore don't have to worry about differing versions of the file in your directories.
-This is very helpful for testing our devonfw-ide, because e.g. the commandlets folder for testing is not the same as the commandlets folder for git-commits. 
+This is very helpful for testing our IDEasy, because e.g. the commandlets folder for testing is not the same as the commandlets folder for git-commits.
 Install https://schinagl.priv.at/nt/hardlinkshellext/linkshellextension.html[link shell extension] and follow the instructions for installation and  usage first. 
 Later on you can make symbolic links of files or folder from your "git folder" and add them into the folder in which the testing is supposed to take place:
 
-So select the folder `${DEVON_IDE_HOME}/workspaces/ide/scripts/src/main/resources/scripts/command/` and choose `Pick Link Source` and then go to `${DEVON_IDE_HOME}/scripts/` delete the `command` folder and re-create it as symbolic link via `Drop as... > Symbolic link`.
+So select the folder `${IDE_HOME}/workspaces/ide/scripts/src/main/resources/scripts/command/` and choose `Pick Link Source` and then go to `${IDE_HOME}/scripts/` delete the `command` folder and re-create it as symbolic link via `Drop as... > Symbolic link`.
 Do the same also for `functions`, `functions-core`, `commandlet-cli`, `environment-project`, `environment-project.bat`, `devon`, `devon.bat`, `autocomplete`, and `devon-autocomplete`.
 Now changes you make in the first mentioned file  will directly be available in your testing environment through the created file-link in the testing environment.
 
@@ -151,13 +151,13 @@ Have a look at https://github.com/devonfw/ide/blob/master/documentation/advanced
 You probably know this black box on Windows (the Command Prompt) that accepts commands like 'dir' that shows the content of the directory you are currently in,
 or 'cd' with which you can change the directory you are currently in and many more commands that allow you to interact with your Windows Operating System in a more direct and eventually faster way.  
 Now for users of a Linux Distribution there is something similar, but way more powerful, usually called "Bourne Again Shell", or in short Bash.
-This Command Line Interface or "Shell" is what we use most often when implementing something new for our Command-Line-Tool with the name devonfw-ide.  https://www.youtube.com/watch?v=I4EWvMFj37g[Have a look at Bash in 150 Seconds.]
+This Command Line Interface or "Shell" is what we use most often when implementing something new for our Command-Line-Tool with the name IDEasy.  https://www.youtube.com/watch?v=I4EWvMFj37g[Have a look at Bash in 150 Seconds.]
 For MacOS you often also use BASH.
 That's why it is often enough to implement code for Mac or Linux (at least to some extend as you'll see soon enough) to be able to use it on both Operating Systems.
 
 Let's get to the practical part of the Bash-usage. 
 
-**If you are using Windows**, make sure that you have git-bash installed, so you can execute the Bash commands mentioned in this introduction. [Here you can find git for windows](https://git-scm.com/download/win). In some cases later on you may want or need to use WSL. Our project teams standard way is to install WSL via Rancher Desktop, which is easily installable with the devonfw-ide by using the command `devon docker setup`. If you don't have the devonfw-ide yet, then you can follow [this guide](https://github.com/devonfw/ide/blob/master/documentation/setup.asciidoc)
+**If you are using Windows**, make sure that you have git-bash installed, so you can execute the Bash commands mentioned in this introduction. [Here you can find git for windows](https://git-scm.com/download/win). In some cases later on you may want or need to use WSL. Our project teams standard way is to install WSL via Rancher Desktop, which is easily installable with the IDEasy by using the command `ide install docker`. If you don't have the IDEasy yet, then you can follow [this guide](https://github.com/devonfw/ide/blob/master/documentation/setup.asciidoc)
 
 The https://www.youtube.com/watch?v=oxuRxtrO2Ag[following video] gives you some important and helpful basics, still you don't need to know all of these commands directly by heart. Instead under the video you'll find a list with the commands mentioned in the video to make a command return to your mind. Also directly play around with those commands while watching the video to learn faster. 
 
@@ -187,4 +187,4 @@ In case you want to get your hands dirty with code that is already in use and co
 There are also some basic exercises related to our project that are not official yet, but you can ask for if you want to try some of them out to learn and challenge yourself a bit.
 
 == Documentation
-Scroll down on https://github.com/devonfw/ide[this site] to get an overview of the documentation sections for the devonfw-ide, e.g. Home, Features, Download & Setup or have a look at https://github.com/devonfw/ide/tree/master/documentation[the documentation files folder].
+Scroll down on https://github.com/devonfw/ideasy[this site] to get an overview of the documentation sections for the IDEasy, e.g. Home, Features, Download & Setup or have a look at https://github.com/devonfw/ideasy/tree/main/documentation[the documentation files folder].

documentation/advanced-tooling-mac.asciidoc

@@ -5,11 +5,11 @@ toc::[]
 
 == Finder
 
-If you want to open a terminal from a folder in Finder and automatically get your environment set properly for `devonfw-ide` you will find the perfect solution here.
+If you want to open a terminal from a folder in Finder and automatically get your environment set properly for `IDEasy` you will find the perfect solution here.
 
-image::images/finder-integration.png["devonfw-ide integration in MacOS Finder"]
+image::images/finder-integration.png["IDEasy integration in MacOS Finder"]
 
-So after installing (see below) the integration(s) provided here, you can easily open a terminal ready for your `devonfw-ide`:
+So after installing (see below) the integration(s) provided here, you can easily open a terminal ready for your `IDEasy`:
 
 * right click (`[control]` + click) on file or folder in `Finder`
 * Expand the `Quick-Actions` sub-menu
@@ -20,14 +20,14 @@ So after installing (see below) the integration(s) provided here, you can easily
 mvn -v
 ```
 
-To get this feature for macOS `Terminal.app` open Finder and run the workflow `system/mac/terminal/Open_devonfw-Terminal_here.workflow` (in `${DEVON_IDE_HOME}`). For iTerm2.app (that can be installed from `App Store`) do the same with `system/mac/iterm/Open_devonfw-iTerm_here.workflow`.
+To get this feature for macOS `Terminal.app` open Finder and run the workflow `system/mac/terminal/Open_devonfw-Terminal_here.workflow` (in `${IDE_HOME}`). For iTerm2.app (that can be installed from `App Store`) do the same with `system/mac/iterm/Open_devonfw-iTerm_here.workflow`.
 
 == Keyboard
 
 Keyboard support is not an integration however, some users coming from other platforms may struggle with the way macOS deals with (external non-apple) keyboards.
 So to make it short: if you are happy with your keyboard and shortcuts, you can skip all the following.
 Otherwise, if you think that pressing keys like `Home`, `End`, etc. should just work as expected or pressing `Alt Gr` should allow you to type the special characters as printed on your German keyboard then here you will find a solution to your problems!
-To get all automated you can just run the script `system/mac/keyboard/install-mac-keyboard-support.sh` (in `${DEVON_IDE_HOME}`).
+To get all automated you can just run the script `system/mac/keyboard/install-mac-keyboard-support.sh` (in `${IDE_HOME}`).
 If you would like to understand what is going on, you want to customize the keyboard settings to your needs, or you want a keyboard layout other than German ISO, please read on.
 
 === Keyboard Layouts
@@ -42,7 +42,7 @@ To install keyboard layouts simply double-click the `bundle` or copy it to `~/Li
 To actually use them go to `System Preferences` and select `Keyboard`.
 Then, select the tab `Input Sources`.
 With the `+` button you can add a keyboard layout for your daily usage with your Mac.
-Please note that the keyboard layout shipped with `devonfw-ide` is called `German-ISO` and can be found in the `Others` section at the end of the list.
+Please note that the keyboard layout shipped with `IDEasy` is called `German-ISO` and can be found in the `Others` section at the end of the list.
 It can be used as an example or template, if you want to create your own layout.
 
 image::images/keyboard-layouts.png["Keyboard Preferences / Input Sources"]

documentation/cli.asciidoc

@@ -1,32 +1,32 @@
 :toc:
 toc::[]
 
-= Devon CLI
+= Ide CLI
 
-The `devonfw-ide` is shipped with a central command `devon`. The link:setup.asciidoc[setup] will automatically register this command so it is available in any shell on your system. This page describes the Command Line Interface (CLI) of this command.
+`IDEasy` is shipped with a central command `ide`. The link:setup.asciidoc[setup] will automatically register this command so it is available in any shell on your system. This page describes the Command Line Interface (CLI) of this command.
 
-== Devon
-Without any argument the `devon` command will determine your `DEVON_IDE_HOME` and setup your link:variables.asciidoc[environment variables] automatically. In case you are not inside of a `devonfw-ide` folder the command will echo a message and do nothing.
+== Ide
+Without any argument the `ide` command will determine your `IDE_HOME` and setup your link:variables.asciidoc[environment variables] automatically. In case you are not inside of a `IDEasy` folder the command will echo a message and do nothing.
 
 [source,bash]
 --------
-[/]$ devon
-You are not inside a devon IDE installation: /
+[/]$ ide
+You are not inside an IDEasy installation: /
 [/]$ cd /projects/my-project/workspaces/test/my-git-repo
-[my-git-repo]$ devon
-devonfw-ide has environment variables have been set for /projects/my-project in workspace main
-[my-git-repo]$ echo $DEVON_IDE_HOME
-/projects/devon
+[my-git-repo]$ ide
+IDEasy environment variables have been set for /projects/my-project in workspace main
+[my-git-repo]$ echo $IDE_HOME
+/projects/ide
 [my-git-repo]$ echo $JAVA_HOME
 /projects/my-project/software/java
 --------
 
 == Commandlets
-The `devon` command supports a pluggable set of _commandlets_. Such commandlet is provided as first argument to the devon command and may take additional arguments:
+The `ide` command supports a pluggable set of _commandlets_. Such commandlet is provided as first argument to the ide command and may take additional arguments:
 
-`devon «commandlet» [«arg»]*`
+`ide «commandlet» [«arg»]*`
 
-Technically, a commandlet is a bash script located in `$DEVON_IDE_HOME/scripts/command`. So if you want to integrate another tool with `devonfw-ide` we are awaiting your pull-request.
+Technically, a commandlet is a bash script located in `$IDE_HOME/.ide/scripts/command`. So if you want to integrate another tool with `IDEasy` we are awaiting your pull-request.
 Every commandlet takes the following generic arguments:
 
 .Generic arguments of every commandlet
@@ -38,13 +38,13 @@ Every commandlet takes the following generic arguments:
 |=======================
 
 === Command-wrapper
-For many commandlets the `devon` command acts as a wrapper.
+For many commandlets the `ide` command acts as a wrapper.
 Similar to `mvnw` or `gradlew` you can use it as a proxy command.
-Therefore `devon mvn clean install` will be the same as `mvn clean install`.
-The benefit when using `devon` as wrapper is that it will even work when the command (`mvn`, `node`, `npm`, etc.) is not on your `PATH` variable or even not yet installed.
+Therefore `ide mvn clean install` will be the same as `mvn clean install`.
+The benefit when using `ide` as wrapper is that it will even work when the command (`mvn`, `node`, `npm`, etc.) is not on your `PATH` variable or even not yet installed.
 We see the main benefit in this for writing portable scripts that you may commit to your git repository and that will then run everywhere and will lazily install the required tools on the fly.
-In your daily usage you can and surely should avoid to always type `devon` as prefix to every command.
-However, when you automate and want to avoid "command not found" errors, you can simply prefix the command with `devon`.
+In your daily usage you can and surely should avoid to always type `ide` as prefix to every command.
+However, when you automate and want to avoid "command not found" errors, you can simply prefix the command with `ide`.
 
 === Commandlet overview