Skip to content

Commit c9c23df

Browse files
authored
devonfw#142: renamed repo, updated all references (devonfw#245)
1 parent 52c6bfa commit c9c23df

22 files changed

+62
-68
lines changed

.gitmodules

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[submodule "devon-ide-settings"]
1+
[submodule "ide-settings"]
22
path = settings/src/main/settings
3-
url = https://github.com/devonfw/devon-ide-settings.git
3+
url = https://github.com/devonfw/ide-settings.git
44
branch = master

README.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Tool to automate setup and update of development environment.
44

5-
image:https://img.shields.io/github/license/devonfw/devon-ide.svg?label=License["Apache License, Version 2.0",link=https://github.com/devonfw/devon-ide/blob/master/LICENSE]
5+
image:https://img.shields.io/github/license/devonfw/ide.svg?label=License["Apache License, Version 2.0",link=https://github.com/devonfw/ide/blob/master/LICENSE]
66
image:https://img.shields.io/maven-central/v/com.devonfw.tools.ide/devon-ide-scripts.svg?label=Maven%20Central["Maven Central",link=https://search.maven.org/search?q=g:com.devonfw.tools.ide]
77
image:https://travis-ci.com/devonfw/devon-ide.svg?branch=master["Build Status",link="https://travis-ci.com/devonfw/devon-ide"]
88

documentation/Home.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ TL;DR?
2222
5. happy hacking!
2323

2424
== License
25-
The `devon-ide` is free and open-source. For details read our https://github.com/devonfw/devon-ide/blob/master/TERMS_OF_USE.adoc[TERMS_OF_USE].
25+
The `devon-ide` is free and open-source. For details read our https://github.com/devonfw/ide/blob/master/TERMS_OF_USE.asciidoc[TERMS_OF_USE].

documentation/configuration.asciidoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ The `devon-ide` aims to be highly configurable and flexible. The configuration o
77

88
0. build in defaults (for `JAVA_VERSION`, `ECLIPSE_PLUGINS`, etc.)
99
1. `~/devon.properties` - user specific global defaults (on windows in `%USERPROFILE%/devon.properties`)
10-
2. `https://github.com/devonfw/devon-ide/blob/master/scripts/src/main/resources/scripts/devon.properties[scripts/devon.properties]` - defaults provided by `devon-ide`. Never directly modify this file!
10+
2. `https://github.com/devonfw/ide/blob/master/scripts/src/main/resources/scripts/devon.properties[scripts/devon.properties]` - defaults provided by `devon-ide`. Never directly modify this file!
1111
3. `devon.properties` - vendor variables for custom distributions of `link:scripts.asciidoc[devon-ide-scripts]`, may e.g. tweak `SETTINGS_PATH` or predefine `SETTINGS_URL`.
12-
4. `https://github.com/devonfw/devon-ide-settings/blob/master/devon.properties[settings/devon.properties]` (`${SETTINGS_PATH}/devon.properties`) - project specific configurations from link:settings.asciidoc[settings].
12+
4. `https://github.com/devonfw/ide-settings/blob/master/devon.properties[settings/devon.properties]` (`${SETTINGS_PATH}/devon.properties`) - project specific configurations from link:settings.asciidoc[settings].
1313
5. `workspaces/${WORKSPACE}/devon.properties` - optional workspace specific configurations (espeically helpful in projects using docker).
14-
6. `https://github.com/devonfw/devon-ide-settings/blob/master/devon/conf/devon.properties[conf/devon.properties]` - user specific configurations (e.g. `M2_REPO=~/.m2/repository`). During setup this file is created by copying a template from `${SETTINGS_PATH}/devon/conf/devon.properties`.
14+
6. `https://github.com/devonfw/ide-settings/blob/master/devon/conf/devon.properties[conf/devon.properties]` - user specific configurations (e.g. `M2_REPO=~/.m2/repository`). During setup this file is created by copying a template from `${SETTINGS_PATH}/devon/conf/devon.properties`.
1515

1616
== devon.properties
1717

documentation/configurator.asciidoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ toc::[]
33

44
= Configurator
55

6-
The `devon-ide` maintains and includes a tool called https://github.com/devonfw/devon-ide/tree/master/configurator[devon-ide-configurator]. This allows to synchronize and manage complex configurations. Initially it was written for Eclipse that stores its information in a `.metadata` folder of your workspace. Unfortunately it contains different file-formats (including XML as String value inside properties files), temporary data as well as important configurations with sometimes mixtures of project specific, developer specific, and UI specific settings. To make it short it is a mess. Instead of bashing on Eclipse we want to make this IDE more usable and created a way to manage important parts of such configuration strcutures.
6+
The `devon-ide` maintains and includes a tool called https://github.com/devonfw/ide/tree/master/configurator[devon-ide-configurator]. This allows to synchronize and manage complex configurations. Initially it was written for Eclipse that stores its information in a `.metadata` folder of your workspace. Unfortunately it contains different file-formats (including XML as String value inside properties files), temporary data as well as important configurations with sometimes mixtures of project specific, developer specific, and UI specific settings. To make it short it is a mess. Instead of bashing on Eclipse we want to make this IDE more usable and created a way to manage important parts of such configuration strcutures.
77

88
== How to use
99
The easiest way is that you do not care. When you launch the IDE of your choice (e.g. via `devon eclipse`, `devon vscode` or by running `eclipse-main` script), this will happen automatically.
@@ -32,7 +32,7 @@ In other words this means:
3232

3333
== How to customize
3434

35-
Many fundamental settings for Eclipse can be found in the sub-folder `https://github.com/devonfw/devon-ide/tree/master/settings/src/main/settings/eclipse/workspace/update/.metadata/.plugins/org.eclipse.core.runtime/.settings[.metadata/.plugins/org.eclipse.core.runtime/.settings]`. Of course you could manually edit these settings with a text editor. However, this requires a lot of knowledge. As we want to provide a great user-experience with `devon-ide` you can also do the following:
35+
Many fundamental settings for Eclipse can be found in the sub-folder `https://github.com/devonfw/ide/tree/master/settings/src/main/settings/eclipse/workspace/update/.metadata/.plugins/org.eclipse.core.runtime/.settings[.metadata/.plugins/org.eclipse.core.runtime/.settings]`. Of course you could manually edit these settings with a text editor. However, this requires a lot of knowledge. As we want to provide a great user-experience with `devon-ide` you can also do the following:
3636

3737
* launch your IDE (e.g. `devon eclipse`).
3838
* do the desired modification of the configuration within the IDE's GUI (e.g. in Eclipse preferences)

documentation/features.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Have as many instances of the `devon-ide` "link:setup.asciidoc[installed]" on yo
2727
* *Multiple Workspaces* +
2828
Support working with different link:workspaces.asciidoc[workspaces] on different branches. Create and update new workspaces with few clicks. See the workspace name in the title-bar of your IDE so you do not get confused and work on the right branch.
2929
* *Free* +
30-
The `devon-ide` is free just like everything from http://devonfw.com[devonfw]. See https://github.com/devonfw/devon-ide/blob/master/TERMS_OF_USE.adoc[TERMS_OF_USE] for details.
30+
The `devon-ide` is free just like everything from http://devonfw.com[devonfw]. See https://github.com/devonfw/ide/blob/master/TERMS_OF_USE.adoc[TERMS_OF_USE] for details.
3131

3232
== IDEs
3333
We support the following IDEs:

documentation/integration.asciidoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The `devon-ide` already brings a lot of integration out of the box. This page is
66
OASP4J-IDE ships with a script `IDEenv.bat` that checks if you are currently in a directory (CWD) that belongs to an `devon-ide` project. In that case the script will automatically set the environment variables for that projects. Otherwise the script will have no effect and do no harm.
77
Preparation:
88

9-
* Please copy `IDEenv.bat` from https://github.com/devonfw/devon-ide/tree/master/scripts/src/main/resources/system[system] folder into a central `scripts` folder (e.g. `C:\Users\«MyLogin»\scripts` or `C:\Program Files\scripts`)
9+
* Please copy `IDEenv.bat` from https://github.com/devonfw/ide/tree/master/scripts/src/main/resources/system[system] folder into a central `scripts` folder (e.g. `C:\Users\«MyLogin»\scripts` or `C:\Program Files\scripts`)
1010
* Ensure that this `scripts` directory is added to your system path:
1111
** Got to `Computer > Properties > Advanced system settings > Environment Variables`
1212
** In the upper group (`User variables for ...`) select the variable `PATH`
@@ -17,7 +17,7 @@ Preparation:
1717
=== CMD
1818
If you want to open a `CMD` (MS Dos Shell) directly from `Windows Explorer` for a folder in your `devon-ide` project you will also want to have the environment variables set properly so that you can run `mvn`, `yarn`, `gulp`, or whatever directly from that shell. Therefore you once have to follow these steps:
1919

20-
* Right-click on the file `IDEenv.reg` from https://github.com/devonfw/devon-ide/tree/master/scripts/src/main/resources/system[system] and choose `Merge` from Context-Menu.
20+
* Right-click on the file `IDEenv.reg` from https://github.com/devonfw/ide/tree/master/scripts/src/main/resources/system[system] and choose `Merge` from Context-Menu.
2121
* Confirm the dialog `User Account Control` with `Yes`.
2222
* Confrim the dialog `Registry Editor` with `Yes`.
2323
* Click `OK`.

documentation/license.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
= License
22

33
This software is licensed as Open-Source product for free usage including commercial use.
4-
You need to apply to our https://github.com/devonfw/devon-ide/blob/master/TERMS_OF_USE.adoc[terms of use] before using it.
4+
You need to apply to our https://github.com/devonfw/ide/blob/master/TERMS_OF_USE.asciidoc[terms of use] before using it.
55

documentation/migration-from-devonfw-3.0.0-or-lower.asciidoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ For all the details you should study the documentation starting from the link:Ho
2828
If you get errors:
2929

3030
* ask your technical lead to fix the `links:settings.asciidoc[settings]` git repo for `devon-ide` or offer him to do it for you.
31-
* you need to merge the `https://github.com/devonfw/devon-ide-settings/tree/master/devon[devon]` folder into your settings
32-
* you need to merge the `https://github.com/devonfw/devon-ide-settings/blob/master/devon.properties[devon.properties]` into your settings
31+
* you need to merge the `https://github.com/devonfw/ide-settings/tree/master/devon[devon]` folder into your settings
32+
* you need to merge the `https://github.com/devonfw/ide-settings/blob/master/devon.properties[devon.properties]` into your settings
3333
* you should check your `variables[-customized][.bat]` and merge required customizations into the proper link:configuration.asciidoc[configuration]
3434

3535
== Hints for users after migration

documentation/scripts.asciidoc

+6-6
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
toc::[]
33

44
= scripts
5-
This directory is the heart of the `devon-ide` and contains the required link:https://github.com/devonfw/devon-ide/tree/master/scripts/src/main/resources/scripts[scripts].
5+
This directory is the heart of the `devon-ide` and contains the required link:https://github.com/devonfw/ide/tree/master/scripts/src/main/resources/scripts[scripts].
66

77
.File structure of the conf folder
88
[subs=+macros]
99
----
1010
/scripts
11-
├──/ https://github.com/devonfw/devon-ide/tree/master/scripts/src/main/resources/scripts/command[command]
11+
├──/ https://github.com/devonfw/ide/tree/master/scripts/src/main/resources/scripts/command[command]
1212
│ ├── link:build.asciidoc[build]
1313
│ ├── link:eclipse.asciidoc[eclipse]
1414
│ ├── link:gradle.asciidoc[gradle]
@@ -33,8 +33,8 @@ This directory is the heart of the `devon-ide` and contains the required link:ht
3333
└── link:configuration.asciidoc[devon.properties]
3434
----
3535

36-
The https://github.com/devonfw/devon-ide/tree/master/scripts/src/main/resources/scripts/command[command] folder contains the link:cli.asciidoc#commandlets[commandlets].
37-
The https://github.com/devonfw/devon-ide/tree/master/scripts/src/main/resources/scripts/devon[devon] script is the key link:cli.asciidoc[command line interface] for `devon-ide`. For windows there is also https://github.com/devonfw/devon-ide/tree/master/scripts/src/main/resources/scripts/devon.bat[devon.bat] to be used in CMD or PowerShell.
38-
As the `devon` link:cli.asciidoc[CLI] can be used as global command on your computer from any directory and gets link:setup.asciidoc#install[installed] centrally it aims to be stable, minimal, and leightweight. The key logic to setup the environment variables is therefore in a separate script https://github.com/devonfw/devon-ide/tree/master/scripts/src/main/resources/scripts/environment-project[environment-project] and its Windows variant https://github.com/devonfw/devon-ide/tree/master/scripts/src/main/resources/scripts/environment-project.bat[environment-project.bat] inside this `scripts` folder.
39-
The file https://github.com/devonfw/devon-ide/tree/master/scripts/src/main/resources/scripts/functions[functions] contains a collection of reusable bash functions. These are sourced and used by the link:cli.asciidoc#commandlets[commandlets].
36+
The https://github.com/devonfw/ide/tree/master/scripts/src/main/resources/scripts/command[command] folder contains the link:cli.asciidoc#commandlets[commandlets].
37+
The https://github.com/devonfw/ide/tree/master/scripts/src/main/resources/scripts/devon[devon] script is the key link:cli.asciidoc[command line interface] for `devon-ide`. For windows there is also https://github.com/devonfw/ide/tree/master/scripts/src/main/resources/scripts/devon.bat[devon.bat] to be used in CMD or PowerShell.
38+
As the `devon` link:cli.asciidoc[CLI] can be used as global command on your computer from any directory and gets link:setup.asciidoc#install[installed] centrally it aims to be stable, minimal, and leightweight. The key logic to setup the environment variables is therefore in a separate script https://github.com/devonfw/ide/tree/master/scripts/src/main/resources/scripts/environment-project[environment-project] and its Windows variant https://github.com/devonfw/ide/tree/master/scripts/src/main/resources/scripts/environment-project.bat[environment-project.bat] inside this `scripts` folder.
39+
The file https://github.com/devonfw/ide/tree/master/scripts/src/main/resources/scripts/functions[functions] contains a collection of reusable bash functions. These are sourced and used by the link:cli.asciidoc#commandlets[commandlets].
4040
Finally the `devon.properties` file contains defaults for the general link:configuration.asciidoc[configuration] of `devon-ide`.

0 commit comments

Comments
 (0)