Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#590: Fix Asciidoc files in documentation causing errors #670

Merged
merged 9 commits into from
Oct 10, 2024
7 changes: 3 additions & 4 deletions documentation/LICENSE.adoc
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
= License
:toc:
toc::[]

= License

The product `IDEasy` is licensed under the following terms.

Binaries of this product have been made available to you by https://devonfw.com[devonfw] under the https://github.com/devonfw/ide/blob/master/LICENSE[Apache License 2.0].

The documentation of this product is licensed under the terms of the http://creativecommons.org/licenses/by-nd/4.0/[Creative Commons License (Attribution-No Derivatives 4.0 International)].

All of the source code to this product is available under licenses which are both free and open source.
The source code for this product is available under free and open-source licenses.
hohwille marked this conversation as resolved.
Show resolved Hide resolved

More specifically, most of the source code is available under the Apache License 2.0. The remainder of the software which is not under the Apache License is available under one of a variety of other free and open source licenses.
Those that require reproduction of the license text in the distribution are given below.
Expand All @@ -19,7 +18,7 @@ The following table shows the components that may be used.
The column `inclusion` indicates the way the component is included:

* `directly included` means the component is directly contained in the download package of `IDEasy` we provide
* `default setup` means the component is not initially included but will be downloaded during the link:setup.asciidoc[`setup`] by default
* `default setup` means the component is not initially included but will be downloaded during the link:setup.adoc[`setup`] by default
* `optional` means the component is neither initially included nor downloaded by default, but only gets downloaded and installed if explicitly triggered by you when invoking additional commands or if explicitly configured by your project.

.Third party components
Expand Down
20 changes: 8 additions & 12 deletions documentation/projects.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
:toc:
toc::[]

= Repositories

IDEasy supports to automatically clone and import required git repositories into your IDE during link:setup.asciidoc[setup].
To configure this you put a `.properties` file for each desired repository into the `repositories` sub-folder in your link:settings.asciidoc[settings].
IDEasy supports to automatically clone and import required git repositories into your IDE during link:setup.adoc[setup].
To configure this you put a `.properties` file for each desired repository into the `repositories` sub-folder in your link:settings.adoc[settings].
Each `.properties` file describes one (git) "repository" which you would like to clone and (potentially) import:

[source,properties]
Expand All @@ -20,11 +17,11 @@ import=eclipse,intellij
active=true
----

.Variables of project import
[options="header"]

|=== |*Variable*|*Value*|*Meaning*
|`path`|e.g. `myproject`, will clone into `${WORKSPACE_PATH}/myproject`|(required) Path into which the projects is cloned.
.Variables of project import
[options="header",cols="3"]
|===
|*Variable*|*Value*|*Meaning*
alfeilex marked this conversation as resolved.
Show resolved Hide resolved
|`path`|e.g. `myproject`, will clone into `${WORKSPACE_PATH}/myproject`|(required) Path into which the projects are cloned.
This path is relative to the workspace.
|`working sets`|e.g. `ws1,ws2`|(optional) This will create working sets (in eclipse).
Each module (eclipse project) of this project will be part of all these working sets.
Expand All @@ -42,6 +39,5 @@ For a regular project use `.` to build top-level project.
If omitted no build is triggered.
|`import`|e.g. `intellij`|(optional) IDEs where to automatically import the project.
Currently only maven projects are supported.
|`active`|`true`|(optional) If set to `false` the project is skipped during the link:setup.asciidoc[setup].

|`active`|`true`|(optional) If set to `false` the project is skipped during the link:setup.adoc[setup].
|===
6 changes: 3 additions & 3 deletions documentation/proxy-support.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
:toc:
toc::[]

[[proxy-support.adoc]]
= Proxy support

:toc:
toc::[]

IDEasy provides built-in support for automatic HTTP and HTTPS proxy recognition.

[[proxy-support.adoc_Configuring-Proxy-settings]]
Expand Down
Loading