[Bug 773976] split docs into sub-folders

[GStreamer (GNOME Bugzilla)]

https://bugzilla.gnome.org/show_bug.cgi?id=773976

--- Comment #13 from Tim-Philipp Müller <t.i.m at zen.co.uk> ---
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.

-- 
You are receiving this mail because:
You are the QA Contact for the bug.
You are the assignee for the bug.