Wiki source code of Idea: Help by Default

Last modified by Vincent Massol on 2024/02/26 17:55

Show last authors
1 {{toc start="2"/}}
2
3 == Requirement ==
4
5 > Bundle Help Center application in XWiki
6
7 == Current ==
8
9 * [[Help Center application>>extensions:Extension.Help Center Application.WebHome]] is a separate extension that can be installed on demand
10
11 == Issues ==
12
13 === Issue 1: Uninstallable ===
14
15 (% class="row" %)
16 (((
17 (% class="col-xs-6" %)
18 (((
19 * Bundling means making it a dependency of the XWiki Enterprise flavor, which means that uninstalling the Help Center would uninstall the XWiki Enterprise flavor
20 ** Issue: Users not wanting to see the Help pages inside the Navigation Tree or AppBar would need to manually make the pages hidden
21
22 {{jira url="https://jira.xwiki.org" style="list"}}
23 XWIKI-8608
24 {{/jira}}
25 )))
26
27 (% class="col-xs-6" %)
28 (((
29 {{gallery}}
30 image:panels.png
31 {{/gallery}}
32 )))
33 )))
34
35 === Issue 2: Visible AWM apps ===
36
37 (% class="row" %)
38 (((
39 (% class="col-xs-6" %)
40 (((
41 * Help Center comes with some AWM Demo apps. Some users might want to remove those apps, since they are not content created by them
42 ** For beginner users, the demo applications helps them understand basic XWiki concepts, but after the initial steps they are still visibile
43 * We could decide to make the pages to be hidden, but their purpose is to reflect the reality and demo how AWM apps can be used
44 )))
45
46 (% class="col-xs-6" %)
47 (((
48 {{gallery}}
49 image:AWM-After.png
50 image:AWM-Before.png
51 {{/gallery}}
52 )))
53 )))
54
55 === Issue 3: Flavor ===
56
57 (% class="row" %)
58 (((
59 (% class="col-xs-6" %)
60 (((
61 * Where should the Help be bundled? In the KB flavor or in the Base/XWiki flavor (being available for all flavors that build on top of it)?
62 )))
63 )))
64
65 === Issue 4: Permissions ===
66
67 (% class="row" %)
68 (((
69 (% class="col-xs-6" %)
70 (((
71 * Should the Help pages be protected against editing, in order to prevent deleting important info?
72 )))
73 )))
74
75 === Issue 5: Component ===
76
77 (% class="row" %)
78 (((
79 (% class="col-xs-6" %)
80 (((
81 * What's the difference between the [[Platform's Help component>>https://jira.xwiki.org/browse/XWIKI/component/12947]] and [[Help Center Project>>https://jira.xwiki.org/browse/HELPCENTER]]?
82 )))
83 )))

Get Connected