Follow-up from "Add docs for backing up git data with direct disk access"
Per a discussion on !66159 (merged).
Copying the discussion here:
@cat: One last question - I think @nhxnguyen and I were curious from a tech writing perspective, whether the snippet in this MR makes sense in this context as there is a lot of code compared to just inlining the full code and instructions in this MR, WDYT?
@kpaizee: That's a good question. In the interests of maintaining a single source of truth, it would make sense to add the whole thing to the docs. But as you point out, this is a significant script and it's still experimental, so I think having a link to the snippet for now is alright. Going forward, I would suggest the following:
- Keep the script in an appropriate place in the gitlab-org repo.
- Add the instructions to the docs and include a link to the script.
Does that sound like it could work?
@nhxnguyen: That makes sense to me! @cat Can you think of a good place in the gitlab-org repo to put this? Perhaps something that support uses?
@cat: I'm not sure where in gitlab-org this would be best gitlab-com), WDYT?
Or maybe, we can link to the PoC MR in !65778 (closed) and update the description with the instructions as well? That might make way more sense