Skip to content

Add missing detail about introduction check subcommand

Ben Prescott_ requested to merge docs/bprescott/20220509-praefectchk into master

What does this MR do?

[1] Fix link and details about Omnibus praefect check command.

I don't see a MR in 14.6 that would account for this change, but 14.5 has: omnibus-gitlab!5688 (merged) and relates to gitaly!3989 (merged) both are 14.5

[2] Add mention of the NTP check. This is a first iteration, as I've not documented what to do when it fails.

We have a ticket where this check is failing:

checking with NTP service at and allowed clock drift 60000 ms [correlation_id: 01G2EZGMMKGEG4T90M1K36QC4V]
Failed (fatal) error: gitaly node at tcp://hostname:8075: rpc error: code = DeadlineExceeded desc = context deadline exceeded

But I'm 🌴 this week and so won't be able to add more details until we get to the bottom of it.

Related issues

omnibus-gitlab#6472 (closed)

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Evan Read

Merge request reports