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.

Sign up for GitHub

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

Decide and rename if necessary remaining files name and places #1446

Merged
merged 4 commits into from
Sep 15, 2023
Merged

Decide and rename if necessary remaining files name and places #1446

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
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
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
16 changes: 16 additions & 0 deletions doc/README.md
View file
Open in desktop
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)
2 changes: 1 addition & 1 deletion doc/admin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
- [Alarms](#alarms)

The **IoT Agent node library** is not a standalone product and should be added as a dependency to `package.json` of the
project is going to be used in. The library is published in the NPM repository, so it can be added to the project by
project is going to be used in. The library is published in the npm repository, so it can be added to the project by
adding the following line to the `package.json` file:

```json
Expand Down
17 changes: 6 additions & 11 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,10 @@ pages:
- Home: 'index.md'
- 'Getting Started' : 'getting-started.md'
- 'User & Programmers Manual':
- 'Architecture' : 'architecture.md'
- 'IoT Agent API' : 'api.md'
- 'Advanced Topics' : 'advanced-topics.md'
- 'Library Functions': 'usermanual.md'
- 'Measurement Transformation Expression Language': 'expressionLanguage.md'
- 'How to develop a new IoT Agent': 'howto.md'
- 'North Port - NGSI Interactions': 'northboundinteractions.md'
- 'Development Documentation': development.md
- 'Installation & Administration Manual':
- 'Installation Guide': 'installationguide.md'
- 'Operations (logs & alarms)': 'operations.md'

- 'Installation and administration manual': 'admin.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'