Error on the IO documentation -- where to report issues?

[phord]

I don't see any place to report problems on the Adafruit IO Documentation pages. Maybe a link should be added there on the FAQ. (I tried the github repos, but can't find it.)

On the Services > Time page, the time/iso at https://io.adafruit.com/phord/services/time has the wrong description for the ISO-8601 API. It shows the description for the seconds API instead.

Code: Select all

/time HTTP API
GET /api/v2/time/seconds
Get the current time in Unix epoch seconds.

GET /api/v2/time/millis
Get the current time in Unix epoch milliseconds.

GET /api/v2/time/ISO-8601
Get the current time in Unix epoch seconds.

[phord]

There is also a bug in the Jupyter notebook here:
https://hub.gke.mybinder.org/user/brent ... rial.ipynb

In this code:

Code: Select all

try:
    test_feed = aio.feeds('test-feed')
except RequestError: # Doesn't exist, create a new feed
    test_feed = Feed(name='test-feed')         #<-- This line
    test_feed = aio.create_feed(test)

The first assignment in the `except` should be `test`, not `test_feed`.
[/code]
test = Feed(name='test-feed')
[/code]

[brubell]

Hi there,

The Adafruit IO Documentation is hosted publicly on GitHub here: https://github.com/adafruit/Adafruit_IO_Documentation

You can submit an issue for this documentation (https://github.com/adafruit/Adafruit_IO ... ion/issues) with a description of the error. You could also fix the erroneous text and submit a pull request (https://github.com/adafruit/Adafruit_IO ... tion/pulls). Either would be appreciated :)

There is also a bug in the Jupyter notebook here:
https://hub.gke.mybinder.org/user/brent ... rial.ipynb

Could you submit an issue or pull request to this repository directly: https://github.com/adafruit/adafruit_io ... ter/issues. Thanks.

- Brent R.

[phord]

Thanks for the pointer to the repos. I sent a pull-request for the Jupyter page bug.

But I already checked in the Adafruit_IO_Documentation repo, and the other bug is not there.
That repo contains the documentation source for https://io.adafruit.com/api/docs/.
The bug I am reporting is found on the IO Services page itself. For example, https://io.adafruit.com/brubell/services/time

For example, the "Time Service" web page says this at the top:

Code: Select all

    Adafruit IO always knows what time it is...

But that message does not appear anywhere in the Adafruit_IO_Documentation repo.

Code: Select all

    git/opc/Adafruit_IO_Documentation(master)» git grep knows
    git/opc/Adafruit_IO_Documentation(master)»

It's not a huge problem, but it's clearly a mistake and I wanted to point it out to someone. But I still can't find the source for it. :-\

[brubell]

Hi Phord,

I filed a request to fix the /services/time page documentation to our internal bug tracker. Thanks for reporting this. I also suggested that we break out the services documentation to the public API documentation

[brubell]

Hi Phord,

On the Services > Time page, the time/iso at https://io.adafruit.com/phord/services/time has the wrong description for the ISO-8601 API. It shows the description for the seconds API instead.

This has been updated on the webpage.