Reviewing documentation for uPortal, it is split between the old wiki, the uPortal repo and the uPortal-start repo. Creating and updating documentation should have a low barrier, so let's reduce this by making it clear where docs should go.
To start brainstorming, I have a few thoughts ...
- we should prefer uPortal-start over uPortal since most implementors and devs will have uPortal-start cloned/forked
- uPortal repo docs should link to uPortal-start, at the top of most doc pages for times when searching leads to such a page directly
- uPortal repo docs should target uPortal developers as their audience
- uPortal-start repo should target uPortal implementors, admins, UX designers, users, and service owners/managers
- Might want to cut the docs across roles
- Overlapping concepts should not be duplicated, but rather linked to a single doc
- Implementors are operations folks that are tasked with running uPortal on servers or in the Cloud
- concerns: integrations with enterprise systems, service configuration, network details
- Admins are individuals with admin access, managing configuration via UI
- concerns: data files, content management, user management
- UX designers are technical folks that build out custom skins and layouts
- concerns: skinning (CSS / Less), layouts, and maybe theming
- Users: given the high degree of customization, their experience may vary greatly
- concerns: how to log in, how to reset layout (for the few institutions that allow customizing layouts)
- Service owners: people responsible for portal services at an institution
- concerns: cost of ownership, security, performance impact to users, uPortal advantages over other options
Anyway, that's just what's been floating in my head of late. Please feel free to chime in!
Benito J. Gonzalez
Text: 209.777.2754 [hidden email]