Elgato_dark/fleet
1
0
Fork 0
mirror of https://github.com/fleetdm/fleet synced 2026-05-24 01:18:42 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 59

Handbook: update sentence case section and UI to follow (#12686)

Browse source 
- Update sentence case section in the handbook to clarify that role
names and features in the Fleet product are not proper nouns and thus
shouldn't be capitalized
- Update one spot in the Fleet UI to reflect this
This commit is contained in:
Noah Talerman 2023-07-11 01:10:57 -04:00 committed by GitHub
parent 361fcad29b
commit 9eb1ab6745
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
frontend/pages/queries/QueryPage/components/QueryForm/QueryForm.tsx
View file

@ -491,7 +491,7 @@ const QueryForm = ({
Observers can run
</Checkbox>
<p>
Users with the Observer role will be able to run this query on
Users with the observer role will be able to run this query on
hosts where they have access.
</p>
</>

2
handbook/company/why-this-way.md
View file

@ -257,7 +257,7 @@ In sentence case, we write and capitalize words as if they were in sentences:
> Ask questions about your servers, containers, and laptops running Linux, Windows, and macOS
As we use sentence case, only the first word is capitalized. But, if a word would normally be capitalized in the sentence (e.g., a proper noun, an acronym, or a stylization) it should remain capitalized.
As we use sentence case, only the first word is capitalized. But, if a word would normally be capitalized in the sentence (e.g., a proper noun, an acronym, or a stylization) it should remain capitalized. User roles (e.g., "observer" or "maintainer" and features (e.g. "automations") in the Fleet product aren't treated as proper nouns and shouldn't be capitalized.
The reason for sentence case at Fleet is that everyone capitalizes differently in English, and capitalization conventions have not been taught very consistently in schools. Sentence case simplifies capitalization rules so that contributors can deliver more natural, even-looking content with a voice that feels similar no matter where you're reading it.