Add a repository import troubleshooting guide
ClosedPublic
Actions

Authored by epriestley on Jun 21 2015, 12:53 PM.

Details

Reviewers

joshuaspence
btrahan

Maniphest Tasks

T8615: Write a guide for troubleshooting repository imports

Commits

Restricted Diffusion Commit
rP95fe4f94511f: Add a repository import troubleshooting guide

Summary

Fixes T8615. Basic overview of the pipeline, where to look for errors, and how to identify/understand/fix/force your way through.

Test Plan

Read documentation.

Diff Detail

Repository

rP Phabricator

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

epriestley updated this revision to Diff 32385.Jun 21 2015, 12:53 PM

epriestley retitled this revision from to Add a repository import troubleshooting guide.

epriestley updated this object.

epriestley edited the test plan for this revision. (Show Details)

epriestley added reviewers: btrahan, joshuaspence.

epriestley added a task: T8615: Write a guide for troubleshooting repository imports.

Herald added a subscriber: epriestley. · View Herald TranscriptJun 21 2015, 12:53 PM

Overall, I think that there's a bunch of paragraphs which are too short (one or two sentences). I left some inline comments, but nothing major.

I also feel that we could do a better job of detecting errors importing repositories and surfacing them in the UI, similar to the way that setup issues are surfaced to administrators. We could maybe show failed daemon tasks in the Diffusion UI as well, by basically looking for failed daemon tasks where the objectPHID matches the given repository.

src/docs/user/field/repository_imports.diviner
5	I think this should be "troubleshooting OF repositories".
10–11	My English isn't great, but I feel like "or push new commits to a hosted repository" should maybe be in parentheses.
15	Typo of "individual".
27	This reads odd to me, maybe "creating stub objects for them".
28	Maybe we should explain that a commit will have multiple IDs, namely: Internal integer ID (which is not really used anywhere and possibly not worth mentioning) Commit hash PHID
30	Where is the update phase documented? If someone starts their reading at this article, then this might be a little unclear.
41	Does this style any differentially if the `:` is bold? I think that having the `:` in bold is more correct, but I'm not sure if it actually makes a difference. On another note, I've often wondered if we should have an easier way to produce a `<dl>`-type list.
118	Stray `)`
249	Personally, I think that bullet points read nicer if the sentence starts with an uppercase character.