Comments from review of AMY docs and corresponding UI operations

[elichad]

Dumping all my notes from a thorough read of the AMY docs and corresponding operations on the test server. Many of them are small things and I'll make a PR to fix as many of those as possible. Some probably deserve their own issues.

Questions:

• [x] what criteria make an instructor or other Person 'active' vs 'inactive?' Am I right in thinking that people are made inactive manually?
• [x] under what criteria would you archive a Person?
• [x] Training requests: Is there any particular reason why we allow matching trainees to multiple TTT events? I expected it'd throw an error but it didn't.

Outdated things in docs:

• [ ] Organization: Affiliated organizations not used - hide/remove?
• [x] Membership: Person roles (Trainer missing from docs)
• [x] Event: URL validation error suggests pointing to a github repo rather than a github.io site
• [ ] Add Person to Event: Title and URL are not used - hide/remove?
• [x] Docs: various references to separate DC/LC/SWC badges/demos/instructors etc
• [x] Find workshop staff: Badge filter has been changed to a couple of checkboxes

Miscellaneous issues:

• [x] Docs: links to community guide/admin guide on homepage are broken
• [x] Docs: anchor links don't have a proper icon, just a hard-to-see box
• [ ] dropdowns start to 404 if the page is kept open for a long time (5-10 min), displaying "The results could not be loaded." I assume this is a form timeout and possibly deliberate? But it's not that clear that that's what's happening.
• [ ] Documentation missing for some of the Person tabs - Consents and Community Roles
• [x] New Event: certain tags must be added to match the selected curriculum, but the warning if you don't doesn't tell you which tags are needed. (Also, I wonder if we need those tags to be user-selectable at all or if we can add them automatically?)
• [x] Docs: "URL Enter in the workshop's url (to the GitHub page, not the repo)" could be clearer as often "GitHub page"=repo
• [ ] New Event: Sometimes an extra blank entry appears when entering the first email into 'additional people to contact.' I assume this isn't causing problems though.
• [ ] Banner isn't fixed when scrolling horizontally (but getting this right for all zooms/screen sizes might be tricky?)
• [x] Request training form: family name is a required field here even though it's not required in AMY.
• [x] Request training form: Duplicate text 'This response is optional and doesn't impact your application's ranking.'
• [x] Find workshop staff: Clarify that selecting lessons will return only instructors who can teach all of those lessons

Accessibility issues:

Moved to #2332

[maneesha]

what criteria make an instructor or other Person 'active' vs 'inactive?' Am I right in thinking that people are made inactive manually? under what criteria would you archive a Person?

These are both part of the soon-to-be-defined archival process; there is no current system.

[maneesha]

Training requests: Is there any particular reason why we allow matching trainees to multiple TTT events? I expected it'd throw an error but it didn't.

Yes, someone can be matched to multiple TTT events if the had to re-take a training.

[maneesha]

Organization: Affiliated organizations not used - hide/remove?

This is another example of a feature that was implemented but not fully thought through. We had wanted to be able to identify organizations that are identified with each other through their own networks (not through The Carpentries).

For example, in the United States, there is the University of California system. Within that, there are many colleges and universities (University of California Los Angeles, University of California Irvine, University of California San Francisco, etc...). We wanted to be able to identify all organizations that were part of a given network.

The relationship matching was difficult to enforce. We never used this feature, and should consider whether we want to keep it.

[maneesha]

@elichad can put in PRs to update these items:

• Membership: Person roles (Trainer missing from docs)
• Event: URL validation error suggests pointing to a github repo rather than a github.io site
• url_validation_out_of_date
• Docs: various references to separate DC/LC/SWC badges/demos/instructors etc
• Find workshop staff: Badge filter has been changed to a couple of checkboxes

For this item:

Add Person to Event: Title and URL are not used - hide/remove?

That's correct - we aren't using those fields. This was brought up for in this issue which I said I'd start on but never did... this would be a good issue for @elichad

[maneesha]

For all of the accessibility issues - we are planning to do a comprehensive accessibility audit of AMY this year. @elichad can you open a new issue that is a log of all accessibility issues we come across so we have a good starting point for that?

[elichad]

dropdowns start to 404 if the page is kept open for a long time (5-10 min), displaying "The results could not be loaded." I assume this is a form timeout and possibly deliberate? But it's not that clear that that's what's happening.

From django-select2 docs:

The timeout of select2’s caching backend determines how long a browser session can last. Once widget is dropped from the cache the json response view will return a 404

We can configure the timeout of the Django cache used for select2 if we want - the default is 300 seconds.

Note that the current behaviour is technically a WCAG failure under 2.2.1 Timing Adjustable.