fleet icon indicating copy to clipboard operation
fleet copied to clipboard

Engineering README.md housekeeping

Open mike-j-thomas opened this issue 2 years ago • 6 comments

Changes related to https://github.com/fleetdm/confidential/issues/1530 plus some housekeeping while I was in there.

  • migrated Fleet docs from Community to Engineering

  • I added "Writing documentation" training to the "Fleet docs" section

  • added a new on-call engineer responsibility for improving the documentation

  • re-formatted on-call responsibilities section for improved readability

  • added "In this section" content links to sections with more than three sub-sections

  • modified some headings to be compatible with build script anchor links

  • [x] @eashaw, the anchor link on line 257 (Host extra data and JOINs) does not compile correctly. Possibly something to do with the uppercase "JOIN"?

Checklist for submitter

  • [x] Manual QA for all new/changed functionality

mike-j-thomas avatar Aug 03 '22 11:08 mike-j-thomas

@mike-j-thomas Since there is a suspected rendering issue here, I removed the request for review from the page maintainer until it's ready for them to review. My understanding is that this should not yet be merged because it introduces a rendering issue. Since it's not ready to merge yet, can you change it to be a draft PR? That will help make sure it's not accidentally merged in the meantime.

mikermcneil avatar Aug 03 '22 13:08 mikermcneil

@mike-j-thomas Since there is a suspected rendering issue here, I removed the request for review from the page maintainer until it's ready for them to review. My understanding is that this should not yet be merged because it introduces a rendering issue. Since it's not ready to merge yet, can you change it to be a draft PR? That will help make sure it's not accidentally merged in the meantime.

@mikermcneil Done. I probably used the wrong language. No rendering problems as such, just the link is broken. You're right that it should not be merged yet, though. Thanks.

mike-j-thomas avatar Aug 03 '22 14:08 mike-j-thomas

@mike-j-thomas @eashaw :+1: I think if you lowercase the word "JOINs" in the section heading, this will be solved. I'd recommend doing that rather than changing code. (Otherwise, if there's a situation where the capitalization is useful and we don't want to lose it, you can copy the section heading URL that's generated, which likely has a few extra dashes, but is otherwise functional)

mikermcneil avatar Aug 03 '22 14:08 mikermcneil

I think if you lowercase the word "JOINs" in the section heading

@mikermcneil. Already did in this PR, but no luck. image I wondered if it is because "JOIN" is consecutive all caps, because changing title case to lower case usually works.

mike-j-thomas avatar Aug 03 '22 14:08 mike-j-thomas

@mike-j-thomas I updated this PR with the correct link to that heading.

eashaw avatar Aug 03 '22 23:08 eashaw

@zwass, just a nudge for a review, pls. Thanks.

mike-j-thomas avatar Aug 10 '22 00:08 mike-j-thomas

@zwass FYI this one slipped past the 1 business day SLA and is collecting merge conflicts.

Will you please review and merge?

Relates to https://github.com/fleetdm/fleet/issues/7303#issuecomment-1220071069, which is something we can start ASAP so that major improvements to the docs happen each and every week through the close read, overhaul, and verification of correctness of one doc page per week.

mikermcneil avatar Aug 18 '22 23:08 mikermcneil

In the future it will be much easier to review and resolve conflicts if a PR is kept to a single purpose. Right now I'm trying to parse out all of the various changes across the multiple files, only some of which relate to the Engineering team's work.

zwass avatar Aug 19 '22 19:08 zwass

Thanks, @zwass and apologies. Fwiw, i did notice that after the fact. I'll make sure to split up PRs better 👍🏻

mike-j-thomas avatar Aug 19 '22 21:08 mike-j-thomas