Opened 3 years ago
Last modified 3 years ago
#17252 new task
Move the User Guide into a new repository — at Version 5
| Reported by: | jt15s | Owned by: | nielx |
|---|---|---|---|
| Priority: | normal | Milestone: | Unscheduled |
| Component: | Documentation | Version: | |
| Keywords: | Cc: | ||
| Blocked By: | Blocking: | ||
| Platform: | All |
Description (last modified by )
The User Guide should be moved to a new repo as discussed starting here https://github.com/haiku/website/pull/558#issuecomment-915697919 The reasoning behind this (as outlined by PulkoMandy) is that each time Haiku is built, the user guide is also built with it. Thus, they are regenerated each time something in Haiku's source changes and that's why Software Update and pkgman have updates to the user guide so often. Building it separately (for example at haikuports) and versioning it independently would solve this issue.
It would also solve the problem that sometimes people will try to submit change requests to fix problems in the userguide, and we have to redirect them to the userguide editor/translator tool instead.
Additionally, it should be moved to a new subdomain such as userguide.haiku-os.org to make it easier to remember.
Change History (5)
comment:1 by , 3 years ago
comment:2 by , 3 years ago
Ah ok. Thank you for clarifying, this was not mentioned in the initial discussion on GitHub. I think I'll change this ticket to just moving it to another subdomain then.
comment:3 by , 3 years ago
| Description: | modified (diff) |
|---|
comment:4 by , 3 years ago
No, as PulkoMandy outlines in there, it would be good to bundle it separately from the rest of Haiku for a variety of reasons, including that it would decouple the versions.
comment:5 by , 3 years ago
| Description: | modified (diff) |
|---|
Replying to jt15s:
I am not going to comment on two places. The userguide in the source code is not the primary source, but a copy of what is being maintained as part of https://i18n.haiku-os.org/userguide/
The argument that it needs to be moved out of the Haiku repository for that reason is moot.
I am leaning on closing this ticket as wontfix but I will give reporter the chance to narrow it down to changing the domain.
About that point though: it _was_ on a separate domain before, but the powers that be decided to integrate it when they migrated to Hugo. It would be responsible to review why that change was made then, and to see whether those arguments still hold up (before moving things around again).