GNOME Bugzilla – Bug 773976
split docs into sub-folders
Last modified: 2016-11-16 09:40:29 UTC
And `npm install && ./node_modules/bower/bin/bower install` needs to be run inside it, then make clean && clean should do the trick.
Created attachment 339164 [details] [review] Update theme submodule
Created attachment 339165 [details] [review] Split out installing documentation to separate folder.
*** Bug 773975 has been marked as a duplicate of this bug. ***
(In reply to Mathieu Duponchelle from comment #0) > And `npm install && ./node_modules/bower/bin/bower install` needs > to be run inside it, then make clean && clean should do the trick. make clean && clean even!
Hm and hotdoc needs to be updated to latest pip: ``` pip install --update hotdoc hotdoc-c-extension ``` I'll simplify all this a bit more at some point it's annoying.
Created attachment 339169 [details] [review] Update theme submodule
Cleaned up some search issues, nothing major
OK so git didn't like much my renaming and fixing links in the same commit, and I ended up with a rather huge commit, history is preserved though. Attaching the resulting structure for validation, the following directories are omitted for the sake of brevity: * examples, the tutorials/ code has been moved in there * the hotdoc theme submodule, which is now in theme/
Created attachment 339287 [details] New directory structure
(In reply to Mathieu Duponchelle from comment #8) > OK so git didn't like much my renaming and fixing links in the same commit, > and I ended up with a rather huge commit, history is preserved though. Actually that was just my version of git (2.5.5) acting up, with git built from git master the patch is much more attachable
Created attachment 339312 [details] [review] Slit documentation into subfolders
Created attachment 339350 [details] [review] Split out documentation into subfolders The previous patch was breaking the paths to tutorials source code, this is now fixed.
Thanks for taking care of the split-up Mathieu. Just some final bits of bikeshedding/brainstorming. I'm working off the sitemap here since the attachment isn't easy to add-as-comment because of the special chars. > installing/.. Seems ok to me. > manual/ > manual/introduction/ > ... > manual/building/ > ... > manual/advanced/ > ... > manual/highlevel/index.md > ... > manual/appendix/index.md > ... I'm wondering whether we should use this opportunity to rename the "manual" subdirectory to something more descriptive, like "application-development" or such. I think the manual/building/ subdirectory is confusingly named (this is based on the existing filenames of course), maybe it should be "basic" instead? Or maybe we should not do subdirectories for the manual at all? > tutorials/ > ... > deploying/ > ... > tools/ > ... Looks fine to me. > pwg/ > pwg/introduction/ > ... > pwg/building/ > ... > pwg/advanced/ > ... > pwg/other/ > ... > pwg/appendix/ > ... Similar questions as for the manual really. - should we rename "pwg" to something more expressive? "plugin-writing" or "plugin-development" or such? - pwg/building/ seems confusingly named (based on old filenames) - pwg/other/ is not very well named, looks like it's more for specific use cases. Anyway, this is mostly just to sound out what people think. If there's a consensus towards anything we might go for it right away. If not we don't have to block on it, it just means we skip some renames/moves later ;) Sebastian wanted for images to be placed alongside the markdown docs where they're used IIRC. This can always be changed later though, doesn't affect public site structure. Not entirely sure about the markdown/ subdirectory (existence plus name), but can live with it and it doesn't affect the public site structure. Can't think of a better name right now either.
(In reply to Tim-Philipp Müller from comment #13) > > I'm wondering whether we should use this opportunity to rename the "manual" > subdirectory to something more descriptive, like "application-development" > or such. Yes, "manual" was often confusing for people, it's too generic. > I think the manual/building/ subdirectory is confusingly named (this is > based on the existing filenames of course), maybe it should be "basic" > instead? > > Or maybe we should not do subdirectories for the manual at all? Seems ok either way to me, "basic" also makes sense. > > pwg/ > > pwg/introduction/ > > ... > > pwg/building/ > > ... > > pwg/advanced/ > > ... > > pwg/other/ > > ... > > pwg/appendix/ > > ... > > Similar questions as for the manual really. > > - should we rename "pwg" to something more expressive? > "plugin-writing" or "plugin-development" or such? "plugin-development" (and "application-development") > - pwg/building/ seems confusingly named (based on old filenames) > > - pwg/other/ is not very well named, looks like it's more for specific use > cases. "basic" and "higher-level-base-classes"? > Sebastian wanted for images to be placed alongside the markdown docs where > they're used IIRC. This can always be changed later though, doesn't affect > public site structure. Yes please, but can be done later. It's just messy otherwise :) > Not entirely sure about the markdown/ subdirectory (existence plus name), > but can live with it and it doesn't affect the public site structure. Can't > think of a better name right now either. Why does it have to exist?
Sorry long day today, will update tomorrow, some replies though (In reply to Sebastian Dröge (slomo) from comment #14) > (In reply to Tim-Philipp Müller from comment #13) > "basic" and "higher-level-base-classes"? This is starting to become really long and unwieldy to link to, application-development/higher-level-base-classes/whatever.md is a bit meh IMHO :) > > Not entirely sure about the markdown/ subdirectory (existence plus name), > > but can live with it and it doesn't affect the public site structure. Can't > > think of a better name right now either. > > Why does it have to exist? Because I was doing this and I think it's tidier, I don't really see why that would be a problem ?
(In reply to Mathieu Duponchelle from comment #15) > > Why does it have to exist? > > Because I was doing this and I think it's tidier, I don't really see why > that would be a problem ? It's not a problem, just seems weird :) I thought there might be an actual requirement for it to exist
commit b3e43da206e704b3b1efedc7cfae070bb331dc1e Author: Tim-Philipp Müller <tim@centricular.com> Date: Wed Nov 16 09:38:18 2016 +0000 plugin-dev: fix up references for building -> basics rename commit bb3f7a1311813a3bbe7e3c3444f87d41e2c363e0 Author: Tim-Philipp Müller <tim@centricular.com> Date: Wed Nov 16 09:34:29 2016 +0000 plugin-dev: rename "building" subdir to "basics" commit 94e8457569637f6dfce128453abb0b81c08a4672 Author: Tim-Philipp Müller <tim@centricular.com> Date: Wed Nov 16 09:27:05 2016 +0000 plugin-dev: rename "other" subdir to "element-types" https://bugzilla.gnome.org/show_bug.cgi?id=773976 commit 8d41aa5fd642e133a94319878fdc0dd2ac11b316 Author: Tim-Philipp Müller <tim@centricular.com> Date: Tue Nov 15 13:14:26 2016 +0000 Update refs for pwg -> plugin-development rename https://bugzilla.gnome.org/show_bug.cgi?id=773976 commit 369a15bbd5dd889b61222f35c3840629b3bc2583 Author: Tim-Philipp Müller <tim@centricular.com> Date: Tue Nov 15 11:40:16 2016 +0000 Rename pwg/ -> plugin-development/ https://bugzilla.gnome.org/show_bug.cgi?id=773976 commit 81fe854608ea27394c3dcff7ba6110b351174462 Author: Tim-Philipp Müller <tim@centricular.com> Date: Tue Nov 15 11:19:20 2016 +0000 Update TODO commit c4d643e41994a4dc15748ef15c5340f832b61bb9 Author: Tim-Philipp Müller <tim@centricular.com> Date: Tue Nov 15 11:15:11 2016 +0000 faq: update using section a bit commit 761c4786d2045d268a528954c71e0090a3163ef0 Author: Tim-Philipp Müller <tim@centricular.com> Date: Tue Nov 15 11:05:34 2016 +0000 faq: update troubleshooting commit 9a128d2891bfbddc0906207a410214e73f2c5bc1 Author: Tim-Philipp Müller <tim@centricular.com> Date: Tue Nov 15 10:53:38 2016 +0000 faq: update getting commit 9666a222358a492d6c0ecbc4dce4774f94c38c89 Author: Tim-Philipp Müller <tim@centricular.com> Date: Tue Nov 15 10:20:12 2016 +0000 faq: update developing commit e9717e9cee649c4fb6b545eabd7002fa08bacc7f Author: Tim-Philipp Müller <tim@centricular.com> Date: Sat Nov 12 20:46:29 2016 +0000 faq: update dependencies section commit a224ca3afa898ab502cf8e44401491ec8629b8e4 Author: Tim-Philipp Müller <tim@centricular.com> Date: Mon Nov 14 00:53:17 2016 +0000 faq: update general section Remove mention of the aRTSd and esd sound servers and such. commit 0f3b8f0144368b296449cce82ccd86f232ab038b Author: Tim-Philipp Müller <tim@centricular.com> Date: Sat Nov 12 20:48:03 2016 +0000 faq: update index/start page commit 6d67a9f3bdbf86a23414ff64225eadfe940bba68 Author: Tim-Philipp Müller <tim@centricular.com> Date: Mon Nov 14 13:40:45 2016 +0000 faq: add to sitemap commit 25e018821cb684a4934348ce2777b102f0261a1c Author: Tim-Philipp Müller <tim@centricular.com> Date: Thu Nov 10 12:02:55 2016 +0000 faq: initial import Converted with pandoc. commit be894db2158e93011fc46784a3c07505427bd778 Author: Tim-Philipp Müller <tim@centricular.com> Date: Mon Nov 14 16:50:57 2016 +0000 app-dev: rename building/ -> basics/ https://bugzilla.gnome.org/show_bug.cgi?id=773976 commit f1c93b5f66fb7f7b52a304c4c56cc0d66207027b Author: Tim-Philipp Müller <tim@centricular.com> Date: Mon Nov 14 16:29:47 2016 +0000 app-dev: fix up links for rename And fix some broken here and ther as well while at it. commit 3a4697680268f4ed67e7ee4ef99252ed32ef368e Author: Tim-Philipp Müller <tim@centricular.com> Date: Mon Nov 14 14:41:57 2016 +0000 Rename manual/* to application-development/* https://bugzilla.gnome.org/show_bug.cgi?id=773976 commit 0a5edb45df1a8e6cb1df078ff45bdccb0ad7b651 Author: Tim-Philipp Müller <tim@centricular.com> Date: Mon Nov 14 14:31:28 2016 +0000 Fix up README for recent changes commit 09f71131fbadc2e956eda0df250407a63df93b07 Author: Mathieu Duponchelle <mathieu.duponchelle@opencreed.com> Date: Sat Nov 5 09:18:49 2016 +0100 Split out documentation into subfolders. https://bugzilla.gnome.org/show_bug.cgi?id=773976