Public notes #241
Description
Rationale
Currently to share knowledge it's mandatory to have an account to the platform and to have access to a space. We have several use cases requested by end-user to be able to provide notes outside a space:
- on a public site without being connected
- on a page outside a space
To answers these needs, we need to first be able to provide a way to choose the source of the notes displayed in the Note portlets when inserted in different pages.
1. Functional Requirements
Top User Stories
Notes app settings
Note source
Given I'm a platform/admin in a page or a space admin and space publisher in a space page.
When I'm on the app library I have a new app "Public note" in the section "General tools"
When the portlet is not set, I have a CTA "Select note source" displayed for space admin, space publisher (in a space page only) or platform/admin. For other users the portlet is not displayed.
When I open the settings of the app, I have 2 options:
- Note source: to display the notes of one selected space.
- Hide navigation: to display/hide the side navigation treeview, TOC inside note and breadcrumb. By default it's displayed.
For note source
I can select only one space then the level of the treeview I want to display. By default, it's the Home note selected. I can click on an "Edit" action to display the note treeview and select a level. Only this note and those below it will be displayed on the portlet.
I can select one sub-note without selecting the parent but if I select 2 sub-notes the parent is automatically selected as we need to have a parent note displayed in the treeview.
If I select a parent, the sub-note will be automatically selected but I can unselect some sub-notes.
Unselecting a parent, unselect the children automatically.
If one note selected, the navigation will be automatically hidden and we cannot deactivate the option until we select several notes.
Selecting the different sources, will make the note available based on the page permission. User with access to the page where the app is added will be able to see the notes. It also the case if the portlet is added to a public site, the note will be public.
Impacts
Gamification
Notifications
Analytics
The view content point need to be updated to track also the display of notes from this new portlet.
A view from this portlet will track a "View content" measuring point with:
- social ID user if in the login platform, if outside the platform we will have unknown user
Unified Search
Customer delivery
Functionnal
No impact as it's a new portlet so no existing data.
Change management
- None
Technical
2. Technical Requirements
Expected Volume & Performance
Security
Extensibility
Configurability
Upgradability
Existing Features
Feature Flags
| Property Name | Default Value | Target Audience | Functional Behaviour |
|---|---|---|---|
Other Non Functional Requirements
3. Impacts
Documentation
Training
4. Software Architecture
Security
Access
- GUI
- API
Services & processing
- Ex: Scheduled Jobs
Data and persistence
- Macro data model
- Persistence layer
- Use of caches
Clustering
Multitenancy
Integrations
Migration strategy
5. Annexes
- Reasoning that explain the technical choices
- Impacts
- References