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

Publishing API Backend changes: Don't default to checking all #169

Closed
GUI opened this issue Jan 15, 2015 · 1 comment
Closed

Publishing API Backend changes: Don't default to checking all #169

GUI opened this issue Jan 15, 2015 · 1 comment

Comments

@GUI
Copy link
Member

GUI commented Jan 15, 2015

In the api.data.gov admin, when you navigate to the Configuration > Publish Changes screen, by default all of the pending new or modified API Backends are automatically checked for publishing. However, for superuser admins, this default might be particularly dangerous. Since superuser admins can manage all of the API backends, then this screen will default to publishing all of the backend changes across agencies (for example, right now there is 1 new backend and 7 modified backends pending publishing). So if I'm in there just wanting to modify one backend, I find myself having to be quite careful, and constantly uncheck all these other backends so I don't accidentally publish pending changes for other agencies I don't know anything about. As we give api.data.gov superuser access to other 18F ops people, I think this becomes increasingly relevant.

To improve this, I think we should do a couple things:

  • Add a simple "check all/uncheck all" link somewhere on the page, so it's at least less onerous to mass check or uncheck everything.
  • Default to unchecking everything (but possibly only do that for superusers admins).
    • For non-superuser admins, I think they're much more likely to want to publish everything by default. So if everything were unchecked for them, then we'd be asking them to do one more step by checking things first. This might not be a terrible idea, since it would help them be more safe if they begin to have multiple API backends, but I'd just like to make sure we think a bit about how this will impact the typical agency admin before making this default change.
    • Or as another idea, perhaps have things checked by default if there is only 1 pending change (which will be the case for the majority of agencies), and uncheck everything by default if there is more than 1 pending change. I sort of like the sound of that, since it keeps it simpler if you only have 1 API change, but it also keeps things consistent across superusers and non-superusers.
@GUI GUI self-assigned this Jan 15, 2015
GUI added a commit to NREL/api-umbrella-web that referenced this issue Jan 18, 2015
@GUI GUI added this to the Sprint 13 (1/12-1/23) milestone Jan 19, 2015
@GUI
Copy link
Member Author

GUI commented Jan 19, 2015

Fixed in NREL/api-umbrella-web@c86bab1 I ended up taking the second approach: if there is only 1 pending API for publishing, then it is automatically checked. If there is more than 1 pending API, then none of them are checked. There is also now a "check/uncheck all" action. I also added a reminder to the success message after saving an API Backend about it still needing to be published (since I'm not sure if it's intentional that we have so many pending, unpublished APIs).

@GUI GUI closed this as completed Jan 19, 2015
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