Update guides with new install verification and refetch behavior - #30633
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthroughThe documentation was updated across multiple articles to clarify that after software or VPP app installations, Fleet automatically refetches host vitals to update the software inventory. Navigation instructions and uninstall notes for VPP apps were refined, and minor formatting cleanup was performed for consistency. Changes
Assessment against linked issues
Possibly related PRs
Suggested reviewers
Poem
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
articles/install-vpp-apps-on-macos-using-fleet.md (4)
70-76: Unify navigation delimiters for consistencyElsewhere in the doc you use the chevron (
>), not the arrow (->), to denote UI paths (e.g., “Settings > Integrations”). Sticking to one style keeps the doc polished.-3. **Find the app**: Click the **Software** -> **Library** tab on the host details page. +3. **Find the app**: Click the **Software > Library** tab on the host details page. … - the **Details** -> **Activity** -> **Upcoming** tab of this page. Once Fleet has verified - that the app is on the host, the app will show up as **Installed** in the **Software** -> **Library** tab. + the **Details > Activity > Upcoming** tab of this page. Once Fleet has verified + that the app is on the host, the app will show up as **Installed** in the **Software > Library** tab.
72-74: Tighten wording and remove repetitionThe sentence repeats “install/Install” three times in very close proximity. Consider trimming for readability:
-Click "Install" to trigger an install. This action will send an MDM command to the host instructing it to install the app. +Click **Install** to send an MDM command that installs the app on the host.
78-78: Drop unnecessary colon and contractStyle guides generally discourage a lone colon after see. A parenthetical reads more smoothly:
-> Currently, VPP apps can't be uninstalled from devices via Fleet. Please see: [Uninstall App Store apps #20729](https://github.com/fleetdm/fleet/issues/20729). +> Currently, VPP apps can't be uninstalled from devices via Fleet (see [Uninstall App Store apps #20729](https://github.com/fleetdm/fleet/issues/20729)).
101-101: Split long instruction for scannabilityThis bullet is ~290 characters and mixes two distinct actions. Breaking it into two sentences (or list items) improves comprehension and matches earlier bullets.
-1. **Navigate to the MDM integration settings page**: Click your avatar on the far right of the main navigation menu, and then **Settings > Integrations > "Mobile device management (MDM)"** Scroll to the "Volume Purchasing Program (VPP)" section, and click "Edit". +1. **Navigate to the MDM integration settings page**: Click your avatar on the far right of the main navigation menu, then choose **Settings > Integrations > "Mobile device management (MDM)"**. +2. Scroll to the **Volume Purchasing Program (VPP)** section and click **Edit**.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
articles/install-vpp-apps-on-macos-using-fleet.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
articles/install-vpp-apps-on-macos-using-fleet.md
[grammar] ~70-~70: There might be a mistake here.
Context: ...n and selecting Available for install. 4. Install the app: Click the "Actions" d...
(QB_NEW_EN_OTHER)
[grammar] ~72-~72: There might be a mistake here.
Context: ... the far right of the app's entry in the table. Click "Install" to trigger an ins...
(QB_NEW_EN_OTHER)
[grammar] ~73-~73: There might be a mistake here.
Context: ...ion will send an MDM command to the host instructing it to install the app. If th...
(QB_NEW_EN_OTHER)
[grammar] ~74-~74: There might be a mistake here.
Context: ...ne, the upcoming install will show up in the Details -> Activity -> **Upc...
(QB_NEW_EN_OTHER)
[grammar] ~75-~75: There might be a mistake here.
Context: ...ab of this page. Once Fleet has verified that the app is on the host, the app wil...
(QB_NEW_EN_OTHER)
[grammar] ~76-~76: Use proper spacing conventions.
Context: ... in the Software -> Library tab. > Currently, VPP apps can't be uninstalled...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~78-~78: Avoid interrupting sentences with colons.
Context: ...alled from devices via Fleet. Please see: [Uninstall App Store apps #20729](https...
(QB_NEW_EN_OTHER_ERROR_IDS_000069)
[grammar] ~78-~78: Use proper spacing conventions.
Context: .../github.com//issues/20729). ## Install an app via self-service 1. **Op...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~101-~101: End punctuation usually goes inside quotation marks.
Context: ...ntegrations > "Mobile device management (MDM)"** Scroll to the "Volume Purchasing Pro...
(QB_NEW_EN_OTHER_ERROR_IDS_000049)
[grammar] ~101-~101: End punctuation usually goes inside quotation marks.
Context: ...asing Program (VPP)" section, and click "Edit". 2. Delete the token: Find the VP...
(QB_NEW_EN_OTHER_ERROR_IDS_000049)
[grammar] ~101-~101: Use proper spacing conventions.
Context: ...rogram (VPP)" section, and click "Edit". 2. Delete the token: Find the VPP token t...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: publish
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
articles/deploy-software-packages.md (1)
48-54: Unify unordered-list style to silence MD004 and keep docs consistent
All extractor-code items use a dash (-) but the surrounding lists in this article (and others in the repo) use asterisks. The markdown-lint CI currently expects the asterisk style, so this section will keep tripping MD004.- - [.pkg extractor code](…) - - [.msi extractor code](…) - - [.exe extractor code](…) - - [.deb extractor code](…) - - [.rpm extractor code](…) +* [.pkg extractor code](…) +* [.msi extractor code](…) +* [.exe extractor code](…) +* [.deb extractor code](…) +* [.rpm extractor code](…)articles/automatic-software-install-in-fleet.md (2)
35-36: Missing apostrophe in “hosts vitals”-Once the software is installed, Fleet will automatically refetch the hosts vitals and update the software inventory. +Once the software is installed, Fleet will automatically refetch the host's vitals and update the software inventory.This also keeps wording consistent with
deploy-software-packages.md.
41-43: Bullet style diverges from repo convention and triggers MD004The list here switches to asterisks while previous lists in the same doc use dashes. Recommend converting to dashes:
-* After configuring Fleet to auto-install a specific software the rest will be done automatically. -* The policy check mechanism runs on a typical one-hour cadence on all online hosts. -* Fleet will send install requests … +- After configuring Fleet to auto-install a specific software the rest will be done automatically. +- The policy-check mechanism runs on a typical one-hour cadence on all online hosts. +- Fleet will send install requests …articles/install-vpp-apps-on-macos-using-fleet.md (1)
75-78: Minor wording/grammar tweaks for clarity & consistency- the **Details** > **Activity** > **Upcoming** tab of this page. Once Fleet has verified - that the app is on the host, the app will show up as **Installed** in the **Software** > **Library** tab. - After the app is installed, Fleet will automatically refetch the host vitals, which will update the - software inventory. + the **Details** > **Activity** > **Upcoming** tab of this page. Once Fleet verifies + the app is present, it appears as **Installed** in **Software** > **Library**. + After installation, Fleet automatically refetches the host's vitals and updates + the software inventory.– Adds missing apostrophe (host's)
– Removes a couple of extra words for brevity
– Keeps wording parallel with other guides.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
articles/automatic-software-install-in-fleet.md(1 hunks)articles/deploy-software-packages.md(3 hunks)articles/install-vpp-apps-on-macos-using-fleet.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
articles/automatic-software-install-in-fleet.md
[grammar] ~35-~35: Don’t miss an apostrophe.
Context: ...d, Fleet will automatically refetch the hosts vitals and update the software inventor...
(QB_NEW_EN_OTHER_ERROR_IDS_000031)
[grammar] ~35-~35: Use proper spacing conventions.
Context: ...itals and update the software inventory. If the software install fails, you can r...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~37-~37: There might be a mistake here.
Context: ...he software inventory. If the software install fails, you can reset a software automat...
(QB_NEW_EN_OTHER)
[grammar] ~37-~37: There might be a mistake here.
Context: ...t a software automation and trigger the install on all targeted hosts again. To do this...
(QB_NEW_EN_OTHER)
[style] ~37-~37: Consider a more expressive alternative.
Context: ...install on all targeted hosts again. To do this, deselect the policy in the **Poli...
(DO_ACHIEVE)
[grammar] ~37-~37: Use proper spacing conventions.
Context: ... and retrigger the software automations. ## How does it work? * After configuring F...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~39-~39: Use proper spacing conventions.
Context: ...tware automations. ## How does it work? * After configuring Fleet to auto-install ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~41-~41: There might be a mistake here.
Context: ...guring Fleet to auto-install a specific software the rest will be done automatically. * ...
(QB_NEW_EN_OTHER)
[grammar] ~41-~41: Use proper spacing conventions.
Context: ...are the rest will be done automatically. * The policy check mechanism runs on a typ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~42-~42: Use proper spacing conventions.
Context: ...al one-hour cadence on all online hosts. * Fleet will send install requests to the ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~43-~43: Use proper spacing conventions.
Context: ...See the following flowchart for details.
Detailed flowchart App Store (VPP) ap...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~46-~46: Use proper spacing conventions.
Context: ...nstall-workflow.png) Detailed flowchart App Store (VPP) apps won't be installed ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~48-~48: Use proper spacing conventions.
Context: ...app's policy automation off and back on. Uninstalling VPP apps is [coming soon](h...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~50-~50: Use proper spacing conventions.
Context: .../github.com//issues/25497). ## Templates for policy queries Use the fo...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
articles/deploy-software-packages.md
[grammar] ~27-~27: Use proper spacing conventions.
Context: ...oftware” button in the top right corner. * Select the "Custom package" tab. * Choo...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~53-~53: Use proper spacing conventions.
Context: ...tractDebMetadata) - .rpm extractor code .tar.gz archives are uploaded as-is with...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~101-~101: Use proper spacing conventions.
Context: ...itals and update the software inventory. ## Edit the package * **Navigate to the So...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
articles/install-vpp-apps-on-macos-using-fleet.md
[grammar] ~70-~70: There might be a mistake here.
Context: ...n and selecting Available for install. 4. Install the app: Click the "Actions" d...
(QB_NEW_EN_OTHER)
[grammar] ~72-~72: There might be a mistake here.
Context: ... the far right of the app's entry in the table. Click "Install" to trigger an ins...
(QB_NEW_EN_OTHER)
[grammar] ~73-~73: There might be a mistake here.
Context: ...ion will send an MDM command to the host instructing it to install the app. If th...
(QB_NEW_EN_OTHER)
[grammar] ~74-~74: There might be a mistake here.
Context: ...ne, the upcoming install will show up in the Details > Activity > **Upcom...
(QB_NEW_EN_OTHER)
[grammar] ~75-~75: There might be a mistake here.
Context: ...ab of this page. Once Fleet has verified that the app is on the host, the app wil...
(QB_NEW_EN_OTHER)
[grammar] ~76-~76: There might be a problem here.
Context: ...* in the Software > Library tab. After the app is installed, Fleet will ...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~77-~77: There might be a mistake here.
Context: ...h the host vitals, which will update the software inventory. > Currently, VPP ap...
(QB_NEW_EN_OTHER)
[grammar] ~78-~78: Use proper spacing conventions.
Context: ...h will update the software inventory. > Currently, VPP apps can't be uninstalled...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~80-~80: Avoid interrupting sentences with colons.
Context: ...alled from devices via Fleet. Please see: [Uninstall App Store apps #20729](https...
(QB_NEW_EN_OTHER_ERROR_IDS_000069)
[grammar] ~80-~80: Use proper spacing conventions.
Context: .../github.com//issues/20729). ## Install an app via self-service 1. **Op...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~103-~103: End punctuation usually goes inside quotation marks.
Context: ...ntegrations > "Mobile device management (MDM)"** Scroll to the "Volume Purchasing Pro...
(QB_NEW_EN_OTHER_ERROR_IDS_000049)
[grammar] ~103-~103: End punctuation usually goes inside quotation marks.
Context: ...asing Program (VPP)" section, and click "Edit". 2. Delete the token: Find the VP...
(QB_NEW_EN_OTHER_ERROR_IDS_000049)
[grammar] ~103-~103: Use proper spacing conventions.
Context: ...rogram (VPP)" section, and click "Edit". 2. Delete the token: Find the VPP token t...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
🪛 markdownlint-cli2 (0.17.2)
articles/automatic-software-install-in-fleet.md
41-41: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
42-42: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
43-43: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
articles/deploy-software-packages.md
53-53: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: markdown-link-check
- GitHub Check: build (20.x)
- GitHub Check: build-binaries
- GitHub Check: publish
🔇 Additional comments (1)
articles/deploy-software-packages.md (1)
101-102: 👍 Clear explanation of automatic refetch behaviour
Good call-out; no issues spotted.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (7)
articles/automatic-software-install-in-fleet.md (3)
35-37: Remove unintended Markdown line-break and double-space.The trailing double space after “inventory.” forces a
<br>in rendered Markdown and was flagged by LanguageTool. It doesn’t appear you need an explicit line-break here, so the extra spaces can be removed to avoid random formatting.-Once the software is installed, Fleet will automatically refetch the host's vitals and update the software inventory.·· +Once the software is installed, Fleet will automatically refetch the host's vitals and update the software inventory.
41-41: Add missing comma after introductory clause.The sentence reads a bit heavy without a comma after the opening clause.
-* After configuring Fleet to auto-install a specific software the rest will be done automatically. +* After configuring Fleet to auto-install a specific software, the rest will be done automatically.
50-50: Minor wording tweak for smoother reading.“is coming soon” reads more naturally than “is coming soon” with the link tucked inside the sentence.
-Uninstalling VPP apps is [coming soon](https://github.com/fleetdm/fleet/issues/25497). +Uninstalling VPP apps is coming soon ([issue #25497](https://github.com/fleetdm/fleet/issues/25497)).articles/install-vpp-apps-on-macos-using-fleet.md (4)
70-70: Keep punctuation outside the bold span for cleaner formatting.Including the period inside the bold markup renders the punctuation in bold, which is inconsistent with the rest of the doc.
-... selecting **Available for install.** +... selecting **Available for install**.
75-78: Collapse hard-wrapped lines to avoid odd mid-sentence breaks.These four lines render as separate paragraphs because of the line breaks. Keeping them on one physical line (or using only soft-wraps in your editor) ensures Markdown treats them as a single paragraph.
- the **Details** > **Activity** > **Upcoming** tab of this page. Once Fleet has verified - that the app is on the host, the app will show up as **Installed** in the **Software** > **Library** tab. - After the app is installed, Fleet will automatically refetch the host's vitals, which will update the - software inventory. + the **Details** > **Activity** > **Upcoming** tab of this page. Once Fleet has verified that the app is on the host, the app will show up as **Installed** in the **Software > Library** tab. After the app is installed, Fleet will automatically refetch the host's vitals, which updates the software inventory.
80-80: Drop the colon and bring punctuation inside the link for consistency.-> Currently, VPP apps can't be uninstalled from devices via Fleet. Please see: [Uninstall App Store apps #20729](https://github.com/fleetdm/fleet/issues/20729). +> Currently, VPP apps can’t be uninstalled from devices via Fleet. See [Uninstall App Store apps #20729](https://github.com/fleetdm/fleet/issues/20729) for updates.
103-103: Insert a period before “Scroll” to split the run-on sentence.-...** "Mobile device management (MDM)"** Scroll to the "Volume Purchasing Program (VPP)" section, and click "Edit". +...** "Mobile device management (MDM)"**. Scroll to the "Volume Purchasing Program (VPP)" section, and click **Edit**.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
articles/automatic-software-install-in-fleet.md(1 hunks)articles/install-vpp-apps-on-macos-using-fleet.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
articles/automatic-software-install-in-fleet.md
[grammar] ~35-~35: Use proper spacing conventions.
Context: ...itals and update the software inventory. If the software install fails, you can r...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~37-~37: There might be a mistake here.
Context: ...he software inventory. If the software install fails, you can reset a software automat...
(QB_NEW_EN_OTHER)
[grammar] ~37-~37: There might be a mistake here.
Context: ...t a software automation and trigger the install on all targeted hosts again. To do this...
(QB_NEW_EN_OTHER)
[style] ~37-~37: Consider a more expressive alternative.
Context: ...install on all targeted hosts again. To do this, deselect the policy in the **Poli...
(DO_ACHIEVE)
[grammar] ~37-~37: Use proper spacing conventions.
Context: ... and retrigger the software automations. ## How does it work? * After configuring F...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~39-~39: Use proper spacing conventions.
Context: ...tware automations. ## How does it work? * After configuring Fleet to auto-install ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~41-~41: There might be a mistake here.
Context: ...guring Fleet to auto-install a specific software the rest will be done automatically. * ...
(QB_NEW_EN_OTHER)
[grammar] ~41-~41: Use proper spacing conventions.
Context: ...are the rest will be done automatically. * The policy check mechanism runs on a typ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~42-~42: Use proper spacing conventions.
Context: ...al one-hour cadence on all online hosts. * Fleet will send install requests to the ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~43-~43: Use proper spacing conventions.
Context: ...See the following flowchart for details.
Detailed flowchart App Store (VPP) ap...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~46-~46: Use proper spacing conventions.
Context: ...nstall-workflow.png) Detailed flowchart App Store (VPP) apps won't be installed ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~48-~48: Use proper spacing conventions.
Context: ...app's policy automation off and back on. Uninstalling VPP apps is [coming soon](h...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~50-~50: Use proper spacing conventions.
Context: .../github.com//issues/25497). ## Templates for policy queries Use the fo...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
articles/install-vpp-apps-on-macos-using-fleet.md
[grammar] ~70-~70: There might be a mistake here.
Context: ...n and selecting Available for install. 4. Install the app: Click the "Actions" d...
(QB_NEW_EN_OTHER)
[grammar] ~72-~72: There might be a mistake here.
Context: ... the far right of the app's entry in the table. Click "Install" to trigger an ins...
(QB_NEW_EN_OTHER)
[grammar] ~73-~73: There might be a mistake here.
Context: ...ion will send an MDM command to the host instructing it to install the app. If th...
(QB_NEW_EN_OTHER)
[grammar] ~74-~74: There might be a mistake here.
Context: ...ne, the upcoming install will show up in the Details > Activity > **Upcom...
(QB_NEW_EN_OTHER)
[grammar] ~75-~75: There might be a mistake here.
Context: ...ab of this page. Once Fleet has verified that the app is on the host, the app wil...
(QB_NEW_EN_OTHER)
[grammar] ~76-~76: There might be a problem here.
Context: ...* in the Software > Library tab. After the app is installed, Fleet will ...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~77-~77: There might be a mistake here.
Context: ...the host's vitals, which will update the software inventory. > Currently, VPP ap...
(QB_NEW_EN_OTHER)
[grammar] ~78-~78: Use proper spacing conventions.
Context: ...h will update the software inventory. > Currently, VPP apps can't be uninstalled...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~80-~80: Avoid interrupting sentences with colons.
Context: ...alled from devices via Fleet. Please see: [Uninstall App Store apps #20729](https...
(QB_NEW_EN_OTHER_ERROR_IDS_000069)
[grammar] ~80-~80: Use proper spacing conventions.
Context: .../github.com//issues/20729). ## Install an app via self-service 1. **Op...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~103-~103: End punctuation usually goes inside quotation marks.
Context: ...ntegrations > "Mobile device management (MDM)"** Scroll to the "Volume Purchasing Pro...
(QB_NEW_EN_OTHER_ERROR_IDS_000049)
[grammar] ~103-~103: End punctuation usually goes inside quotation marks.
Context: ...asing Program (VPP)" section, and click "Edit". 2. Delete the token: Find the VP...
(QB_NEW_EN_OTHER_ERROR_IDS_000049)
[grammar] ~103-~103: Use proper spacing conventions.
Context: ...rogram (VPP)" section, and click "Edit". 2. Delete the token: Find the VPP token t...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: build (20.x)
- GitHub Check: build-binaries
- GitHub Check: markdown-link-check
- GitHub Check: publish
Checklist for submitter
If some of the following don't apply, delete the relevant line.
Summary by CodeRabbit