View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 5984 | Composr non-bundled addons | General / Uncategorised | public | 2024-10-06 01:37 | 2025-01-04 23:42 |
| Reporter | PDStig | Assigned To | PDStig | ||
| Priority | normal | Severity | feature | ||
| Status | assigned | Resolution | open | ||
| Summary | 5984: Deprecate tutorials; move to Wiki+ pages | ||||
| Description | Deprecate / remove the tutorials addon and migrate all of the content into Wiki+ pages on composr.app . Add re-directs for the docs zone to the new Wiki+ pages. | ||||
| Additional Information | The reason for this change is the community-centric focus of Composr CMS v11. I want to utilise the Wiki+ system from now on for tutorials so members can easily add their own content (via Wiki+ posts) to enhance the tutorials. | ||||
| Tags | Roadmap: Over the horizon | ||||
| Attach Tags | |||||
| Time estimation (hours) | 50 | ||||
| Sponsorship open | |||||
|
|
The existing system lets people submit tutorials and have them presented alongside the Comcode Page-backed ones. There's no reason those could not be hosted on Wiki+. I am concerned about moving documentation off of the Comcode Pages because: 1) Then it can no longer be amended alongside Git contributions. E.g. if a new feature is added to galleries, the documentation cannot be updated alongside that, someone has to separately do that and if anyone wants to ensure quality they need to track that actually is happening (as opposed to it all going through one check point). 2) It will create a spam/quality problem that will take a lot of resources to fight. 3) Links will no longer be stable. For example, if someone decides to move key parts of a tutorial to another page, Composr linking to that tutorial will no longer be correct. Composr's code and the tutorials are tightly coupled. Also merge requests *are* community contributions and GitLab lets you edit markdown pages inside its interface and create a Merge Request from it. We could lean into that, although we'd have to move to markdown (https://compo.sr/tracker/view.php?id=5842). |
|
|
I was also thinking of the potential to hybrid Comcode pages with the Wiki+ via the tutorials addon, because I also thought of that issue since I posted this. Perhaps the non-bundled addon can have special code where the Wiki+ reads in Comcode pages and uses that as the tree structure and page content for the tutorials. And the docs zone entry point would transparently redirect to those Wiki+ pages so that page links still work. While I get merge requests are community contributions, those are geared towards developers. I'd like to make it easier for non-developers to write tutorials. |
|
|
"Perhaps the non-bundled addon can have special code where the Wiki+ reads in Comcode pages and uses that as the tree structure and page content for the tutorials" - it sounds like you are trying to have a unified navigation for content coming from the Git Repository (ultimately) verses what is made on Wiki+. It really isn't very different from what we already have. The current navigation is tag based, and has external tutorials integrated seamlessly into that. There's no reason we couldn't expand "external tutorials" to also just support locally posted tutorials and make it easy to create them. |
|
|
Thinking it over, I agree with you on adding a posting mechanism for external tutorials. It would satisfy the end goal (make tutorial sharing easier and more community oriented) without too much work. |
| Date Modified | Username | Field | Change |
|---|---|---|---|
| 2024-10-06 01:37 | PDStig | New Issue | |
| 2024-10-06 01:37 | PDStig | Status | Not Assigned => Assigned |
| 2024-10-06 01:37 | PDStig | Assigned To | => user4172 |
| 2024-10-06 01:37 | PDStig | Tag Attached: Roadmap: Over the horizon | |
| 2024-10-06 01:37 | PDStig | Tag Attached: Roadmap: v11 partial implementation | |
| 2024-10-06 01:38 | PDStig | Time estimation (hours) | 100 => 50 |
| 2024-10-06 17:22 | Chris Graham | Note Added: 0009436 | |
| 2024-10-06 17:34 | PDStig | Note Added: 0009437 | |
| 2024-10-06 17:35 | PDStig | Note Edited: 0009437 | |
| 2024-10-06 17:35 | PDStig | Note Edited: 0009437 | |
| 2024-10-06 17:47 | Chris Graham | Note Added: 0009438 | |
| 2024-10-06 18:33 | PDStig | Note Added: 0009439 | |
| 2024-10-06 18:33 | PDStig | Note Edited: 0009439 | |
| 2025-01-04 23:42 | PDStig | Tag Detached: Roadmap: v11 partial implementation |
