[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-kimageshop
Subject: Re: Krita Documentation as Git Submodule?
From: Alvin Wong <alvin () alvinhc ! com>
Date: 2021-07-11 10:40:34
Message-ID: 48d0ca96-07a6-9418-0c27-7648db34ce35 () alvinhc ! com
[Download RAW message or body]
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
Emmet O'Neill 於 8/7/2021 13:40 寫道:
> 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
> <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`
> <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.)
>
[Attachment #3 (text/html)]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<p>Hi Emmet,</p>
<p>I think a submodule may not really do much to help, perhaps even
do the opposite. Currently, there are two docs branches:</p>
<ul>
<li>master - where all the editing is going on.</li>
<li>krita/4.3 (stable) - which is built daily and deployed to
docs.krita.org. Translations are also automatically committed
into the repo daily.<br>
</li>
</ul>
<p>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.</p>
<p>This is also not a typical use case of git submodule.<br>
</p>
<p>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.<br>
</p>
<p>Best Regards,</p>
<p>Alvin Wong</p>
<p><br>
</p>
<div class="moz-cite-prefix">Emmet O'Neill 於 8/7/2021 13:40 寫道:<br>
</div>
<blockquote type="cite"
cite="mid:CANZHueaQ+S4K7Yn6kcb-D25d+pehsinTu1TfGEp-z6FYQtGOFQ@mail.gmail.com">
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<div dir="ltr">
<div>Hey all,</div>
<div><br>
</div>
<div>I'm wondering what you all think of the idea of linking
Krita's documentation to the source repository as a [git
submodule.](<a href="https://git-scm.com/docs/git-submodule"
moz-do-not-send="true">https://git-scm.com/docs/git-submodule</a>)</div>
<div><br>
</div>
<div>I'm thinking something along the lines of `git submodule
add <a class="moz-txt-link-abbreviated" \
href="mailto:git@invent.kde.org:documentation/docs-krita-org.git">git@invent.kde.org:documentation/docs-krita-org.git</a> \
docs/` to create a submodule at `source/docs/`.</div>
<div>We can then suggest new devs run `git clone <span
class="gmail-go">--recurse-submodules <a
href="https://invent.kde.org/graphics/krita.git`"
moz-do-not-send="true">https://invent.kde.org/graphics/krita.git`</a>
to pull both the source code and docs at the same time.</span></div>
<div><span class="gmail-go">(Existing copies would run `git pull
--recurve-submodules` or `git pull` followed by `git
submodule update --init` instead.)</span></div>
<div><span class="gmail-go"><br>
</span></div>
<div><span class="gmail-go">Pros / Cons:<br>
</span></div>
<div><span class="gmail-go"><br>
</span></div>
<div><span class="gmail-go">+ Improves accessibility of
documentation and encourages more devs to participate.</span></div>
<div><span class="gmail-go">+ Helps to synchronize specific
source versions with specific documentation versions.<br>
</span></div>
<div><span class="gmail-go">+ Optional in situations where docs
aren't needed (i.e.: build docker) and non-invasive to the
krita-docs-org repo.<br>
</span></div>
<div><span class="gmail-go">- Slightly increases complexity of
source repo, and may take a while to wrap your mind around <span
class="gmail-go">submodules </span>for people who are new
to them.</span></div>
<div><span class="gmail-go">(Possibly others that I'm not
thinking of right now.)</span></div>
<div><span class="gmail-go"><br>
</span></div>
</div>
</blockquote>
</body>
</html>
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic