Skip to content

Commit

Permalink
[INTERNAL] Docs: Clarify virtual path namespaces
Browse files Browse the repository at this point in the history
Virtual paths of libraries do not automatically contain their namespace
(yet).
  • Loading branch information
RandomByte committed Jan 4, 2019
1 parent a274648 commit 0688eca
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ Some general information:
- `configuration`
- `paths`: Mapping between virtual paths and physical paths. Physical paths are always relative to the projects root directory
+ For projects of type `application` a "webapp" path can be configured that will be mapped to the virtual path `/`. By default this is mapped to `webpp`
+ For projects of type `library` a "src" as well as a "test" path can be configured. They will be mapped to the virtual paths `/resources` and `/test-resources` followed by the namespace of the library. By default these paths are mapped to `src` and `test`
+ For type `module`, any kind (and number) of mappings can be configured freely. The key will be used as the virtual path. By default, the projects root directory is mapped to the virtual directory `/`. It is recommended that libraries include their namespace in the virtual path and use the `/resources` prefix.
+ For projects of type `library` a "src" as well as a "test" path can be configured. They will be mapped to the virtual paths `/resources` and `/test-resources`. By default these paths are mapped to `src` and `test`
+ For type `module`, any kind (and number) of mappings can be configured freely. The key will be used as the virtual path. By default, the projects root directory is mapped to the virtual directory `/`. It is recommended that libraries include their namespace in the virtual path and use the `/resources` prefix (e.g. `/resources/my/first/library/module-xy`).

#### builder (optional)
- `customTasks` (optional, list): In this block, you define additional custom build tasks, see [here](./BuildExtensibility.md) for a detailed explanation and examples of the build extensibility. Each entry in the `customTasks` list consists of the following options:
Expand Down

0 comments on commit 0688eca

Please sign in to comment.