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

Documentation improvements #536

Open
dmoranj opened this issue Jan 18, 2017 · 0 comments
Open

Documentation improvements #536

dmoranj opened this issue Jan 18, 2017 · 0 comments

Comments

@dmoranj
Copy link
Contributor

dmoranj commented Jan 18, 2017

After a careful review by @fgalan, a lot of improvement points have been risen for the documentation.

Readme.md

  • Links to the Installation & Administration Guide and User & Programmers Manual are broken.
  • In features, there is a "PENDING" in command execution. That's deprecated. The note about "PENDING" features is also deprecated.
  • "It's up to the particular implementation of the agent to consider whether it should have a persistent storage to hold the device information". This paragraph is ambiguous. It should be clearly stated that it refers to the IoTAgent implementor decision about whether his IoTA should or should not have a in-memory DB.
  • There are some weird quotation marks in the "About API".
  • The 400 return codes in the Device Provisioning section are missing (probably because the documentation is not aligned with the code).
  • The "server.name" references as well as references to the "default" root in APIs should be clarified or removed (roots in the APIs are no longer in use, so they should be removed from both code and documentation).
  • In the API Model to Entity DB Model attribute name mapping, some of the DB Model attribute names are wrong.
  • In Device Provisioning tables the entries for service and subservice are linked to their use with the fiware-XXXX headers. The same link should be added in the device group description.
  • "An updateContext payload in the case of an updateContext middleware and a queryContext payload otherwise". This sentence is ambiguous, should be clarified.
  • Plugin section is quite hard to read. Should be improved and the use of the plugins, the list of available plugins and the development of new ones clearly separated.
  • Typos: Fiware (should use capital letters), NSGI, tranform, haves, device`s, ´TimeInstant´, entity::, with the an optional, code style for some occurrences of '_info' y '_result, and a weird text with "pollingExpiration and pollingDaemonFrequency", ´iotagent-node-lib´

Installation guide

  • Configuration subfields are missing for some configuration parameters. The list of subfields for each parameter should be complete.
  • Indentation failures in JSON fragments.

User manual

  • In the case of functions without parameters, the following function seem to be a parameter, and that looks weird.
  • There is a format error, there is a "###### Params" wrongly located.

Howto

  • There are currently sections for Active and Lazy Attributes, but a section speaking about commands is missing.
  • In #iota-testing there is a list that seems to have been flatten wrong.

There are also some mentions to NGSIv10 and NGSIv9 along the text that should be changed to NGSI10 and NGSI9.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant