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

Merge doc rework into master #1448

Merged
merged 34 commits into from
Sep 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
c0c8018
create admin.md file
mapedraza May 18, 2023
e63071e
Fix old references
mapedraza May 18, 2023
4459044
devel file + rearrangement
mapedraza May 19, 2023
5415d19
Restore api.md toc
mapedraza May 19, 2023
8040101
Restore api.md toc v2
mapedraza May 19, 2023
78f0f2c
Update doc/admin.md
mapedraza May 25, 2023
a1cb5da
restore api.md TOC
mapedraza May 25, 2023
6a9bfa0
Include master lib dependency
mapedraza May 25, 2023
57a6ee5
Apply suggestions from code review
fgalan May 29, 2023
decc600
Merge pull request #1369 from telefonicaid/task/doc-rework-admin
fgalan May 29, 2023
61b267e
Embed howto into development.md
mapedraza Sep 6, 2023
37ab4b7
Fix development TOC
mapedraza Sep 6, 2023
c80b75d
Merge branch 'task/doc-rework' into task/doc-rework-development
mapedraza Sep 6, 2023
1431fc5
Fix links
mapedraza Sep 6, 2023
e46c18c
Add outdated warnings
mapedraza Sep 6, 2023
aef1589
rework datamodel tables
mapedraza Sep 6, 2023
8fe383d
remove bidirectionality from api.md
mapedraza Sep 7, 2023
9390511
addded db warning
mapedraza Sep 7, 2023
2559ca7
Merge pull request #1371 from telefonicaid/task/doc-rework-development
fgalan Sep 7, 2023
376138d
Merge branch 'master' into task/doc-rework-sync
mapedraza Sep 7, 2023
659be09
Merge pull request #1436 from telefonicaid/task/doc-rework-sync
fgalan Sep 7, 2023
10aa0b4
remove plugins references
mapedraza Sep 7, 2023
7b50a96
remove append mode
mapedraza Sep 7, 2023
eea68d8
References to legacy and expressionLanguage
mapedraza Sep 7, 2023
4c0b7ce
switch from update to append
mapedraza Sep 7, 2023
b3c1ed6
Remove eventType reference
mapedraza Sep 11, 2023
653fb28
Merge pull request #1437 from telefonicaid/task/doc-rework-removed-de…
fgalan Sep 11, 2023
7b1c75b
Merge branch 'master' into task/doc-rework-sync2
mapedraza Sep 14, 2023
9566b20
Merge pull request #1445 from telefonicaid/task/doc-rework-sync2
fgalan Sep 14, 2023
6f10a1d
Add readme
mapedraza Sep 14, 2023
d0d350e
Fix mkdocs
mapedraza Sep 14, 2023
c338956
rename README
mapedraza Sep 15, 2023
27d1734
fix lint
mapedraza Sep 15, 2023
4892b84
Merge pull request #1446 from telefonicaid/task/doc-final-files-changes
fgalan Sep 15, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ This project is part of [FIWARE](https://www.fiware.org/). For more information
[IoT Agents](https://github.com/Fiware/catalogue/tree/master/iot-agents).

| :books: [Documentation](https://iotagent-node-lib.rtfd.io) | :mortar_board: [Academy](https://fiware-academy.readthedocs.io/en/latest/iot-agents/idas) | :dart: [Roadmap](https://github.com/telefonicaid/iotagent-node-lib/blob/master/doc/roadmap.md) |
| ---------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |

| ---------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |

## Index

Expand All @@ -47,8 +46,6 @@ functions.
communications are left to the library.
- Standardized OAuth2-based security is available to enable each IoT Agent to connect to several common Identity
Managers (e.g. Keystone and Keyrock) so that communications can be restricted to trusted components.
- A series of additional plugins are offered where necessary to allow for expression parsing, attribute aliasing and
the processing of timestamp metadata.

Each individual IoT Agent offers is driven by a `config.js` configuration file contains explicit custom settings based
on the protocol and payload the IoT Agent is translating. It will also contain some common flags for common
Expand Down Expand Up @@ -76,16 +73,18 @@ const iotagentLib = require('iotagent-node-lib');
```

Information about how to configure the Library can be found at the corresponding section of the
[Installation & Administration Guide](doc/installationguide.md).
[Installation & Administration Guide](doc/admin.md).

## Usage

This library has no packaging or build processes. The [Getting Started](doc/getting-started.md) is a good place to
start. Usage of the library is explained in the [User & Programmers Manual](doc/usermanual.md).
This library has no packaging or build processes. The [Getting Started](./doc/getting-started.md) is a good place to
start. You can also review the [API documentation](./doc/api.md) for a full list of the available functions.

If you plan to use the library in your own IoT Agent, you should read the [Developer Guide](./doc/devel/development.md).
You can also review the [Architecture](./doc/devel/architecture.md) documentation and
[Northbound API](./doc/devel/northbound-api.md).

- Details of the architecture of an IoT Agent be found [here](doc/architecture.md).
- Further Advanced topics can be found [here](doc/advanced-topics.md).
- The following features are listed as [deprecated](doc/deprecated.md).
The following features are listed as [deprecated](doc/deprecated.md).

## API

Expand All @@ -94,7 +93,7 @@ decommission devices. [API](doc/api.md).

## Testing

Contributions to development can be found [here](doc/development.md) - additional contributions are welcome.
Contributions to development can be found [here](doc/devel/development.md) - additional contributions are welcome.

### Agent Console

Expand Down
16 changes: 16 additions & 0 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# IoT Agent documentation

## User documentation

- [Getting started](getting-started.md)
- [IoT Agent API](api.md)
- [Installation and administration manual](admin.md)
- [Deprecated features](deprecated.md)
- [Roadmap](roadmap.md)

## Development documentation

- [Development manual](devel/development.md)
- [Contributing guide](devel/contribution-guidelines.md)
- [Architecture](devel/architecture.md)
- [North Port - NGSI Interactions](devel/northboundinteractions.md)
Loading