Open mapedraza opened 1 year ago
mapedraza
commented
1 year ago Issues / PRs to have into account:
mapedraza
commented
1 year ago PRs that modify the doc after starting the rework:
fgalan
commented
1 year ago PR https://github.com/telefonicaid/iotagent-node-lib/pull/1369 with the admin.md file
mapedraza
commented
1 year ago When merging PR #1371 the status should the following:
| Current file | Current content | Future file | Status |
|---|---|---|---|
| Contribution.md | Contribution guidelines | devel/development.md | ✅ |
| advanced-topics.md | specific topics | api.md | ✅ |
| api.md | API description | api.md | ✅ |
| architecture.md | IoTA Architecture | TBD | |
| deprecated.md | deprecations | deprecated.md | |
| development.md | How to run tests, contribute and coding styles | devel/development.md | ✅ |
| expressionLanguage.md | Information about expressions | api.md | ✅ |
| getting-started.md | Quick userguide | TBD | |
| howto.md | Uso de las funciones para implementar agente | devel/development.md | ✅ |
| index.md | index.md | ||
| installationguide.md | admin.md | ✅ | |
| northboundinteractions.md | TBD | ||
| operations.md | Alarms | admin.md | ✅ |
| roadmap.md | roadmap.md | ||
| usermanual.md | JS functions descriptions (not real user manual, just developer manual) | devel/development.md | ✅ |
The remaining files are:
For the fist 2, they can remain as independent document under devel folder (where they are right now).
deprecated.md, index.md and roadmap.md are also independent files, and they can remain as they are right now (just taking care of updating index.md links)
for getting-started.md, it can be renamed as user-guide, as it guides the IOTA users through the API, configurations, provision and measures sending.
mapedraza
commented
1 month ago After discussing with @fgalan and following the https://github.com/telefonicaid/fiware-orion documentation structure, the final document structure is the following:
| Previous file | Current content | Current file |
|---|---|---|
| Contribution.md | Contribution guidelines | devel/development.md |
| advanced-topics.md | specific topics | api.md |
| api.md | API description | api.md |
| architecture.md | IoTA Architecture | devel/architecture.md |
| deprecated.md | deprecations | deprecated.md |
| development.md | How to run tests, contribute and coding styles | devel/development.md |
| expressionLanguage.md | Information about expressions | api.md |
| getting-started.md | Quick userguide | getting-started.md |
| howto.md | Uso de las funciones para implementar agente | devel/development.md |
| index.md | index.md | |
| installationguide.md | admin.md | |
| northboundinteractions.md | devel/northboundinteractions.md | |
| operations.md | Alarms | admin.md |
| roadmap.md | roadmap.md | |
| usermanual.md | JS functions descriptions (not real user manual, just developer manual) | devel/development.md |
This issue describes future task in order to improve the documentation of IoT Agents. After a initial analysis, the current files need to be reworked and merged into different files. The desired file structure, contining previous documentation is the following:
The implementation plan is creating a branch (
task/doc-rework) with all the documentation changes and merge by creating a PR containing all the changes. Previous smaller PR, one for each file (api.md, admin.md ...) should be opened againsttask/doc-reworkto ease the review.After reworking files, some tasks should be acomplished:
Probably, at this point, merging
task/doc-reworkwithmastershould be considered, since the rest of the takes could take much more time. Then:At this point, iotagent-node-lib 3.4.0 has been released. The remainer tasks would be done in a next version