Hi Emmet,

I think a submodule may not really do much to help, perhaps even do the opposite. Currently, there are two docs branches:

• master - where all the editing is going on.
• krita/4.3 (stable) - which is built daily and deployed to docs.krita.org. Translations are also automatically committed into the repo daily.
  

A git submodule basically points to a specific commit. It is possible to make the submodule track a remote branch, but it still has to be updated manually as a separate step. Given the extra steps required, I feel that the benefit of using a submodule is minimal. Also, the submodule will likely be pointing to an outdated commit most of the time, unless someone commit the submodule update often, which may produce a lot of commit noise in the main repo.

This is also not a typical use case of git submodule.

Nevertheless, we can perhaps give this a trial using a new temporary branch, periodically synced to master by merging master into it, and see how it goes.

Best Regards,

Alvin Wong

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@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.)