View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 5515 | Composr documentation | General / Uncategorised | public | 2023-12-30 19:03 | 2024-07-22 21:42 |
| Reporter | PDStig | Assigned To | |||
| Priority | normal | Severity | feature | ||
| Status | new | Resolution | no change required | ||
| Summary | 5515: Make more visible hidden functionality | ||||
| Description | I believe the hidden functionality of Composr should be made more visible to users, and that we should follow the philosophy of "if it can be configured, then it should be an editable field somewhere". A) Obscure options page Under "Configuration", add a new page that lists off, and allows configuration of, all the hidden values controlling hidden functionality. Perhaps add a function or a hook somewhere that contains a list of arrays ['hidden_value', 'description', 'data_type', 'default_value']. That way, the page can be built off of this without creating full config hooks for every one of them (especially since in general, hidden values are always available regardless of the installed addons). b) URL parameters page In the dropdown that contains items such as showing edit links for templates, add a new option for URL Parameter Builder or something. This pulls up an interface (in a new window?) taking into account the current URL and its parameters. It then has a form which contains all the available URL parameters (such as keep parameters) and allows the user to specify which ones they want (defaults auto-update according to what was originally in the URL). Again, have some list of arrays to build this form: ['parameter', 'description', 'data_type']. Then, with a generate button, a new URL will be generated with those parameters (or we can simply redirect to it). | ||||
| Additional Information | We decided on only improved documentation. See comments. | ||||
| Tags | No tags attached. | ||||
| Attach Tags | |||||
| Time estimation (hours) | |||||
| Sponsorship open | |||||
|
|
I think this is too much cognitive load on people who likely don't ever need the functionality. The most important principle should typically be "don't overwhelm the user who is following the default path" followed by "don't put extra burden on developers unless it is really justified and someone would be willing to pay for it". Most of these options are truly obscure, added for some very specific problem in a hurry. They are documented if people want them, having a UI in front is worse than starting from the documentation for unsupported features - it kind of is instead giving people enough rope to hang themselves with. If they all have to be supported instead, that's an unreasonable developer burden that nobody is going to pay for. |
|
|
That makes sense. Perhaps a compromise is a dedicated tutorial page which lists off the available values and a short description of what they are (if we don't already have that... I think we do). |
|
|
It's in the Codebook. It could be split out if you think important. Probably makes sense too actually, given the list has grown. |
|
|
I can do that. I'll give the documentation a review and think this through, then close this and create a new issue for pulling the values out into another document. |
|
|
I think the documentation itself is fine but perhaps we need a test for this... scan for all uses of get_value / set_value in the code and make sure they are referenced on that doc page (with ability to add exclusions by regex pattern or exact match). |
|
|
__specsettings_documented_test_set already does this. |
|
|
__specsettings_documented* |
| Date Modified | Username | Field | Change |
|---|---|---|---|
| 2023-12-30 19:03 | PDStig | New Issue | |
| 2023-12-30 19:03 | PDStig | Status | Not Assigned => Assigned |
| 2023-12-30 19:03 | PDStig | Assigned To | => user4172 |
| 2024-03-24 19:04 | Chris Graham | Note Added: 0008420 | |
| 2024-03-25 17:00 | PDStig | Note Added: 0008438 | |
| 2024-03-27 13:39 | Chris Graham | Note Added: 0008457 | |
| 2024-03-27 13:53 | PDStig | Note Added: 0008462 | |
| 2024-03-30 03:25 | PDStig | Additional Information Updated | |
| 2024-03-30 03:26 | PDStig | Tag Attached: Roadmap: v11 | |
| 2024-03-30 03:26 | PDStig | Project | Composr alpha bug reports => Composr documentation |
| 2024-04-28 01:10 | PDStig | Note Added: 0008696 | |
| 2024-07-22 21:37 | Chris Graham | Note Added: 0008881 | |
| 2024-07-22 21:37 | Chris Graham | Status | Assigned => Closed |
| 2024-07-22 21:37 | Chris Graham | Resolution | open => no change required |
| 2024-07-22 21:37 | Chris Graham | Tag Detached: Roadmap: v11 | |
| 2024-07-22 21:42 | PDStig | Note Added: 0008882 |
