-
Notifications
You must be signed in to change notification settings - Fork 89
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
[Doc Rework] Create admin.md #1369
Conversation
doc/api.md
Outdated
@@ -2,66 +2,6 @@ | |||
|
|||
<!-- TOC --> | |||
|
|||
- [Preface](#preface) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this removal of the TOC intentional?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, unfortunately was unexpected behaviour of ToC creation plugin used in text editor. Now disabled. A further commit will restore it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Restored here: a1cb5da
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Beware the plugins! :D
## Error naming code | ||
|
||
Every error has a code composed of a prefix and an ID, codified with the following table: | ||
|
||
| Prefix | Type of operation | | ||
| :--------------- | :--------------------------------------------------------- | | ||
| MONGODB | Errors related with the MongoDB repository | | ||
| IOTAM | Errors related with the IoTA Manager | | ||
| KEYSTONE | Errors related with trust token retrieval | | ||
| ORION | Errors in Context Broker access | | ||
| VALIDATION-FATAL | Errors related with management of the Validation templates | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this section exists in the new document?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, in section Logs:
iotagent-node-lib/doc/admin.md
Lines 503 to 524 in 78f0f2c
## Logs | |
This section describes the logs that can be generated by the IoT Agent library. The IoT Agent library uses the following | |
log levels: | |
| Level | Description | | |
| :------ | :-------------------------------------------------------------------------------- | | |
| `DEBUG` | Used to log information useful for debugging. | | |
| `INFO` | Used to log information about the normal operation of the IoT Agent library. | | |
| `ERROR` | Used to log information about errors that may affect the IoT Agent library. | | |
| `FATAL` | Used to log information about fatal errors that may affect the IoT Agent library. | | |
Additionally, every error log has an associated error code that can be used to identify the error. The error codes are | |
composed by a prefix and a number. The following table shows the prefixes used in the IoT Agent library: | |
| Prefix | Type of operation | | |
| :----------------- | :--------------------------------------------------------- | | |
| `MONGODB` | Errors related with the MongoDB repository | | |
| `IOTAM` | Errors related with the IoTA Manager | | |
| `KEYSTONE` | Errors related with trust token retrieval | | |
| `ORION` | Errors in Context Broker access | | |
| `VALIDATION-FATAL` | Errors related with management of the Validation templates | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
NTC
Co-authored-by: Fermín Galán Márquez <[email protected]>
"iotagent-node-lib": "x.y.z", | ||
} | ||
``` | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
where `x.y.z` is a particular version of the library (of the ones included [here](https://www.npmjs.com/package/iotagent-node-lib?activeTab=versions)) | |
In addition, the following fragment could be include (I cannot use it in the suggestion due to the usage of ```):
As alternative, you can use the master branch as dependency. In this case, you will be using the latest version of the code but note that some instability could exist (as the code in master is work in progress until the next version is closed).
...
"dependencies": {
"iotagent-node-lib": "https://github.com/telefonicaid/iotagent-node-lib.git#master",
}
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done in 6a9bfa0
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
This PR merge
installationguide.md
andoperations.md
intoadmin.md
file.This PR is part of a bigger series #1329
Note this PR points towards
task/doc-rework
branch