Skip to content

Some documentation feedback #6

@sideview-nick

Description

@sideview-nick

In section 2, under “Redirect URI(s)”, the docs have the user open the Account > Add form just to get the redirect URI.
It should say in there somewhere “dont submit the form yet”. Possibly explaining that we only opened the form now to get the redirect URL and we’ll come back to it later.
Otherwise the user may assume they’re supposed to submit the form and wonder where the heck the clientid comes from etc.
(in a world where most docs are pretty bad and out of date, this is an easy assumption to make)

Documentation: setting scopes, I recommend listing the scopes that have to be checked, in the same order in which they appear. Since they’re currently in a random order the admin has to hunt repeatedly up and down through the gigantic list and it takes many painful minutes. Here is the same list of 8 scopes, but reordered to order of appearance:

  • audit:events_read
  • analytics:read_all
  • spark-admin:calling_cdr_read
  • spark-admin:people_read
  • meeting:admin_participants_read
  • meeting:admin_schedule_read
  • meeting:admin_config_read
  • spark:organizations_read

Data Input Screens.
One of the modular inputs requires the start time in a different strftime format, with milliseconds. Not a big deal but it was just momentarily confusing to the admin who might be pasting the same starttime from the previous modinput screen and wondering why it suddenly doesn’t work. Presumably there is no reason to have millisecond granularity just on starttime for that one modinput, so consistency would be better.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions