Add a KBI with insights from #15 on config overrides #98
Conversation
There was a problem hiding this comment.
Thx @adswa . There are a few small things to address, once they are done it should be good to merge FMPOV
kbi/0026/index.rst
Outdated
| This shortcoming was `fixed`_ in May 2023. | ||
| At the time of writing, and the fix can be enabled with an installation of `datalad-next`_ and the configuration ``datalad.extensions.load next``, as detailed in the projects documentation. |
There was a problem hiding this comment.
Not sure that this was meant:
| This shortcoming was `fixed`_ in May 2023. | |
| At the time of writing, and the fix can be enabled with an installation of `datalad-next`_ and the configuration ``datalad.extensions.load next``, as detailed in the projects documentation. | |
| This shortcoming was `fixed`_ in May 2023. The fix can be enabled with an installation of `datalad-next`_ and the configuration ``datalad.extensions.load next``, as detailed in the projects documentation. |
There was a problem hiding this comment.
what do you mean, one sentence per line?
There was a problem hiding this comment.
I should have more clearly stated my thoughts!
I assumed that line 35 and line 36 were split by "edit-error" and meant to be one line, that expresses what I suggested as line 35, i.e. "This shortcoming was fixed_ in May 2023. The fix can be enabled with an installation of datalad-next_ and the configuration datalad.extensions.load next, as detailed in the projects documentation.".
But I could not be certain that was what you intended, so I commented with: "Not sure that this was meant"
There was a problem hiding this comment.
Typically I write text as one sentence per line, because it makes it easier to see which logical unit changes belong to with a Git diff.
It does not make any difference for the rendering (see e.g., the preview from the CI https://psyinf-knowledge-base--98.org.readthedocs.build/kbi/0026/index.html) in case this is what you are concerned with? Only if a blank line is in between two sentences the paragraph is split.
kbi/0026/index.rst
Outdated
| This shortcoming was `fixed`_ in May 2023. | ||
| At the time of writing, the fix can be enabled with an installation of `datalad-next`_ and the configuration ``datalad.extensions.load next``, as detailed in the projects documentation. | ||
|
|
||
| The alternative workaround requires the use of Git configurations in environment variables. |
There was a problem hiding this comment.
It is not obvious to me how this line connects the following paragraph to the previous one. To what specific issue is the use of Git configurations in environment variables an "alternative workaround"? I read it as "the following is an alternative to using datalad-next to solve the issue of not being able to override the git user name", but what then follows is a description and solution of a different issue (cloning from a shared repo). I'm guessing the issues and workarounds are supposed to be interpreted on a more abstract level, and examples are given to make it more tangible, but I think some rephrasing could be done to make this message clearer.
There was a problem hiding this comment.
thanks for the critical review, I really appreciate that! I have pushed a restructuring, could you give it a read when its convenient for you and see if that improves coherence?
There was a problem hiding this comment.
Restructured content makes it all much clearer, thanks!
|
Nope, I'm happy with the adjustments. |
This KBI is an attempt to document some of the knowledge gathered in #15, and point out that shortcomings of datalad configs in core can be fixed by using next. It is still a bit vague for my liking, but I struggled with finding a better way - maybe this can be shaped further in the next user support session.
It addresses parts of #15.