GNOME Bugzilla – Bug 346247
GNOME Goal: Switch to yelp-tools for documentation
Last modified: 2021-06-09 20:35:50 UTC
Planner should be switched over to gnome-doc-utils[1,2] for documentation. It will also provide status to translators so they can be on top of everything. [1]http://live.gnome.org/GnomeDocUtilsMigrationHowTo [2]http://live.gnome.org/GnomeDocUtilsMigration
*** Bug 398486 has been marked as a duplicate of this bug. ***
gnome-doc-utils shouldn't be used anymore. yelp-tools should be used instead. The new relevant wiki page is https://live.gnome.org/GnomeGoals/NewDocumentationInfrastructure
would be nice to get this merged
Merging would mean having a patch, which we don't as far as I can see. But I agree, solving this would be nice. :)
Created attachment 353147 [details] [review] GNOME Goal: Switch to yelp-tools for documentation. For now, GNOME ignores the beautifull Planner User Guide V0.14. Legitimate, Planner does not install it. Apply the patch, and make an install. Planner User Guide is recognized by GNOME. It is installed in the right place. On the command ligne, $ yelp help:planner launches the help system and shows very interesting things. Source: https://wiki.gnome.org/Apps/Yelp/Tools/yelp.m4
Created attachment 353149 [details] [review] freedesktop.org Help System Specification uses the 'help:' URI scheme. Help (F1) works from Planner ! Source : https://www.freedesktop.org/wiki/Specifications/help-spec/
Created attachment 353150 [details] [review] Remove Open Source Metadata Framework (OMF) stuff. No more investigation on bug 782100 left...
What about translations ? There was no help at all. Now, there is "C" help. It is better than nothing. Translated documents were never turn to PO files. It must be done. This is why {C,es,eu}/planner.xml were left. https://wiki.gnome.org/GnomeDocUtilsTranslationMigration And after that ? We have to turn the documentation to Mallard. Windows makefiles should be deleted.
Cannot `git bz apply` the last patch (https://bugzilla.gnome.org/attachment.cgi?id=353150) on master (https://git.gnome.org/browse/planner/commit/?id=a402a3f6321c578d1e7f98ac392f57a8678e1f8e), the other two applied just fine.
Created attachment 353364 [details] [review] Remove Open Source Metadata Framework (OMF) stuff.
I still can't apply the last patch: ``` Applying: Remove Open Source Metadata Framework (OMF) stuff. Using index info to reconstruct a base tree... error: patch failed: docs/user-guide/es/planner-es.omf:1 error: docs/user-guide/es/planner-es.omf: patch does not apply error: patch failed: docs/user-guide/eu/planner-eu.omf:1 error: docs/user-guide/eu/planner-eu.omf: patch does not apply error: Did you hand edit your patch? It does not apply to blobs recorded in its index. Patch failed at 0001 Remove Open Source Metadata Framework (OMF) stuff. The copy of the patch that failed is found in: .git/rebase-apply/patch When you have resolved this problem run "git bz apply --continue". If you would prefer to skip this patch, instead run "git bz apply --skip". To restore the original branch and stop patching run "git bz apply --abort". Patch left in /tmp/Remove-Open-Source-Metadata-Framework-OMF-stuff-GmDR4t.patch ``` Not sure why though, it seems like simply removing those files.
(In reply to Andrew Miloradovsky from comment #11) > I still can't apply the last patch: > error: patch failed: docs/user-guide/eu/planner-eu.omf:1 > error: docs/user-guide/eu/planner-eu.omf: patch does not apply > Not sure why though, it seems like simply removing those files. Yes, the patch actually tries to remove the .omf files under `docs/user guide/`. git-am gives me the same result as in comment 11. If I specify the --ignore-whitespace option, the patch apply. The eu and .omf files come from another world where white spaces are treated differently ... I can not produce a unique patch that removes the files. I have a two-patch solution: the first regularizes them (dos2unix, recode, xmllint), the second removes them. I do not like it. In face of mighty Microsoft technology, I surrender... Can anyone propose an applicable "git-format" patch that removes .omf files under `docs/user-guide/`?
-- GitLab Migration Automatic Message -- This bug has been migrated to GNOME's GitLab instance and has been closed from further activity. You can subscribe and participate further through the new bug through this link to our GitLab instance: https://gitlab.gnome.org/World/planner/-/issues/108.