Krita Documentation as Git Submodule?

[Emmet O'Neill]

Hey all,

I'm wondering what you all think of the idea of linking Krita's
documentation to the source repository as a [git submodule.](
https://git-scm.com/docs/git-submodule)

I'm thinking something along the lines of `git submodule add
git at invent.kde.org:documentation/docs-krita-org.git docs/` to create a
submodule at `source/docs/`.
We can then suggest new devs run `git clone --recurse-submodules
https://invent.kde.org/graphics/krita.git` to pull both the source code and
docs at the same time.
(Existing copies would run `git pull --recurve-submodules` or `git pull`
followed by `git submodule update --init` instead.)

Pros / Cons:

+ Improves accessibility of documentation and encourages more devs to
participate.
+ Helps to synchronize specific source versions with specific documentation
versions.
+ Optional in situations where docs aren't needed (i.e.: build docker) and
non-invasive to the krita-docs-org repo.
- Slightly increases complexity of source repo, and may take a while to
wrap your mind around submodules for people who are new to them.
(Possibly others that I'm not thinking of right now.)
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kimageshop/attachments/20210707/54b4e137/attachment.htm>