Details
- Reviewers
- None
- Group Reviewers
Reviewers
Diff Detail
- Repository
- rDDOC Development documentation
- Branch
- gitlab-contrib
- Lint
No Linters Available - Unit
No Unit Test Coverage - Build Status
Buildable 33431 Build 52404: Phabricator diff pipeline on Jenkins for swh-docs Jenkins console · Jenkins Build 52403: arc lint + arc unit
Event Timeline
Build has FAILED
Patch application report for D8969 (id=32311)
Rebasing onto 8d04650792...
Current branch diff-target is up to date.
Changes applied before test
commit 2f5e9e04ef67c99d7b9cf10f2bed8da93ea61472
Author: Benoit Chauvet <contact@benoitchauvet.com>
Date: Mon Dec 19 14:58:30 2022 +0100
gitlab contrib doc draftLink to build: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/293/
See console output for more information: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/293/console
| docs/contributing/gitlab.rst | ||
|---|---|---|
| 17–18 | "For a new contributor" is from the point of view of the writer, not the reader | |
| 47–50 | Double backticks are for monospace, no links. And it's better to linkify text than have the link on its own. | |
| 54–58 | Recommended by who? On what grounds? | |
| 54–70 | Who rec | |
| 104–115 | ||
| 127 | missing line breaks | |
| 133–144 | ||
| 175–205 | seems redundant with the above | |
| 216–263 | this too | |
sounds like it's going the right way, thx!
I've added a couple of suggestions and spotted some typos ;)
| docs/contributing/gitlab.rst | ||
|---|---|---|
| 54–70 | @vlorentz it feels like your question is incomplete ^ @bchauvet you might want to rewrite the "need to configure ssh/git" in the paragraph prior this block ^ with something like: You can also configure your ssh configuration for the gitlab instance to : ... It's not necessary but it can help to do as you suggest. | |
| 92–96 | ||
| 132–133 | maybe add an anchor for later and reference below. | |
| 148 | ||
| 175–205 | Yes. The added value is the bit describing a bit more how to commit and mostly referencing the one way to open the mr (through the log suggestion). @bchauvet Maybe try and merge this inside the main workflow description? | |
| 249–263 | or something ^ | |
| docs/contributing/gitlab.rst | ||
|---|---|---|
| 54–58 | agreed, this remark should be removed | |
fixed the most obvious remarks from the first review. The remaineing points need to be discussed along with finishing the doc contents
This first version is a rst conversion of the doc that's been produced in a pad during the gitlab sprint. It needs to be completed and finalized, ideally during the post-migration grooming sessions.
Build has FAILED
Patch application report for D8969 (id=32463)
Could not rebase; Attempt merge onto ee50b5be9d...
Merge made by the 'recursive' strategy. docs/contributing/gitlab.rst | 287 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 287 insertions(+) create mode 100644 docs/contributing/gitlab.rst
Changes applied before test
commit 486b3f466225929ce829ebdc24bd360544f522ce
Merge: ee50b5b 7959db7
Author: Jenkins user <jenkins@localhost>
Date: Fri Jan 6 09:45:36 2023 +0000
Merge branch 'diff-target'
commit 7959db79018f37097a04b74a464e02dd429172f6
Author: Benoit Chauvet <contact@benoitchauvet.com>
Date: Fri Jan 6 10:42:27 2023 +0100
fix first review's most obvious comments
commit 2f5e9e04ef67c99d7b9cf10f2bed8da93ea61472
Author: Benoit Chauvet <contact@benoitchauvet.com>
Date: Mon Dec 19 14:58:30 2022 +0100
gitlab contrib doc draftLink to build: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/305/
See console output for more information: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/305/console