Skip to content

Commit

Permalink
Revice formatting of config documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
quirogas committed Jul 21, 2023
1 parent 3acc970 commit f9f90e9
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/references/.pages
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ nav:
- Python Adapter Library: python-lib
- ...
- project_config.md
- project_connections_config.md
- global_config.md
7 changes: 6 additions & 1 deletion docs/references/global_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,12 @@ the resulting tag would be `harbor.my-organization.com/my-project-registry/adapt

### `projects` (array of strings)

This array of strings is used by the SDK tools to track the locations of the projects. Each string value is a project location, formatted as a **UNIX** or **DOS** path (host OS). Tracking the location of each project allows the SDK tools be used anywhere in the console besides the project directory. Any time a new project is created, tested, or built, the project is automatically appended to the list. Projects that no longer exist in the specified location are automatically removed.
The SDK tools use this array of strings to track the locations of the projects.
Each string value is a project location, formatted as a **UNIX** or **DOS** path (host OS).
Tracking the location of each project allows
the SDK tools to be used anywhere in the console besides the project directory.
Any time a new project is created, tested, or built, the project is automatically appended to the list.
Projects that no longer exist in the specified location are automatically removed.

??? example
```json
Expand Down
4 changes: 4 additions & 0 deletions docs/references/project_config.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
# Project Config File
* * *

The project config file is a json file called `config.json` located in the project's
root directory. This document describes what data is present in the file.

## `default_memory_limit` (int, default: 1024)

Determines how much memory can be allocated to the container running the adapter. In
addition to the memory required by the Adapter, this includes memory used by the Base
OS layer and the Adapter's REST server. If this limit is exceeded, the container will
immediately exit.

## `docker_port` (int, default: 8080)

Specifies the port for connecting to the Adapter's REST server.
This value should only need to be changed if there is another process already using port 8080.

## `container_repository` (string)

Specifies the container repository to be used by [mp-build](mp-build.md).
This key value should contain the `host` and `path` used to
[tag](https://docs.docker.com/engine/reference/commandline/tag/) and push images to
Expand Down
1 change: 1 addition & 0 deletions docs/references/project_connections_config.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Project Connections File
* * *

!!! warning

Credentials for connections are stored in plain text in the
Expand Down

0 comments on commit f9f90e9

Please sign in to comment.