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

[Doc Rework] Create admin.md #1369

Merged
merged 6 commits into from
May 29, 2023
Merged

[Doc Rework] Create admin.md #1369

merged 6 commits into from
May 29, 2023

Conversation

mapedraza
Copy link
Collaborator

@mapedraza mapedraza commented May 18, 2023

This PR merge installationguide.md and operations.md into admin.md file.

This PR is part of a bigger series #1329

Note this PR points towards task/doc-rework branch

doc/admin.md Outdated Show resolved Hide resolved
doc/api.md Outdated
@@ -2,66 +2,6 @@

<!-- TOC -->

- [Preface](#preface)
Copy link
Member

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?

Copy link
Collaborator Author

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

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Restored here: a1cb5da

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Beware the plugins! :D

Comment on lines -117 to -127
## 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 |
Copy link
Member

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?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, in section Logs:

## 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 |

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NTC

mapedraza and others added 2 commits May 25, 2023 10:41
Co-authored-by: Fermín Galán Márquez <fgalan@users.noreply.github.com>
"iotagent-node-lib": "x.y.z",
}
```

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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",
}

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 6a9bfa0

doc/api.md Outdated Show resolved Hide resolved
doc/admin.md Show resolved Hide resolved
Copy link
Member

@fgalan fgalan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@fgalan fgalan merged commit decc600 into task/doc-rework May 29, 2023
@fgalan fgalan deleted the task/doc-rework-admin branch May 29, 2023 08:30
@fgalan fgalan mentioned this pull request May 29, 2023
25 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants