-
-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
📔✨:restore handbook/styleguide/devdocs conventions #1123
Merged
OpenINFbot
merged 49 commits into
OpenINF:live
from
DerekNonGeneric:feat/add-back-handbook-manual-of-style
Apr 5, 2024
Merged
Changes from 6 commits
Commits
Show all changes
49 commits
Select commit
Hold shift + click to select a range
3f187a8
📔✨:restore handbook/styleguide/devdocs conventions
DerekNonGeneric f252836
Restyled by prettier-markdown
restyled-commits 6961430
📖🚮:rm docs re: windows server
DerekNonGeneric aac6ce0
🏗🚮:rm placeholder .gitkeep file
DerekNonGeneric 946e39a
📖✨: add remaining g-devdocs pages (full-corpus)
DerekNonGeneric 615f586
Restyled by prettier-markdown
restyled-commits 806aaa4
📔✨:restore handbook/styleguide/devdocs conventions
DerekNonGeneric 6526a76
Restyled by prettier-markdown
restyled-commits 77fd894
📖🚮:rm docs re: windows server
DerekNonGeneric 808c7b6
🏗🚮:rm placeholder .gitkeep file
DerekNonGeneric 9d52e96
📖✨: add remaining g-devdocs pages (full-corpus)
DerekNonGeneric 717f412
Restyled by prettier-markdown
restyled-commits c80cffa
Merge branch 'feat/add-back-handbook-manual-of-style' of https://gith…
DerekNonGeneric dc20f3e
fix: add people/person-first language
DerekNonGeneric 9a3cb84
📔✨:restore handbook/styleguide/devdocs conventions
DerekNonGeneric 1c2cc5b
📖🚮:rm g-devdocs -- did not go over smoothly
DerekNonGeneric 95534e0
Update _layouts/handbook-content--g-devdocs-style.html
OpenINFbot 0cd4c49
Update _layouts/handbook-content--g-devdocs-style.html
OpenINFbot 1b51d08
Restyled by prettier-markdown
restyled-commits 8dd2a8e
mv windows stuff to drafts
DerekNonGeneric 6200625
Update _layouts/handbook-content--g-devdocs-style.html
OpenINFbot 56454c2
Update _layouts/handbook-content--g-devdocs-style.html
DerekNonGeneric 2379a82
Update _layouts/handbook-content--g-devdocs-style.html
DerekNonGeneric af27b57
Merge branch 'live' into feat/add-back-handbook-manual-of-style
OpenINFbot b1cdd48
Merge remote-tracking branch 'upstream/live' into feat/add-back-handb…
DerekNonGeneric 01483b8
Merge branch 'live' into feat/add-back-handbook-manual-of-style
DerekNonGeneric 55eae8f
Update collections/_docs/handbook/style/code-syntax.md
DerekNonGeneric 63b3919
i think we can rm this
DerekNonGeneric 159c1e8
Delete gitkeep.gitkeep
DerekNonGeneric 674462b
add license
DerekNonGeneric 0538a26
add key-point include
DerekNonGeneric f111f8d
Update _layouts/handbook-content--g-devdocs-style.html
DerekNonGeneric 504f757
slight corrections
DerekNonGeneric 9d33f14
Update collections/_docs/handbook/style/code-syntax.md
DerekNonGeneric d8be0eb
Merge branch 'live' into feat/add-back-handbook-manual-of-style
DerekNonGeneric cd3a928
let's get this party started
DerekNonGeneric 70c46e8
we may not repeat headings
DerekNonGeneric 37e53ae
this gnarly; we need runbook guidance
DerekNonGeneric fb53a5c
here is an example of showing output
DerekNonGeneric 977bad4
Update collections/_docs/handbook/style/code-syntax.md
DerekNonGeneric 5027428
Merge branch 'live' into feat/add-back-handbook-manual-of-style
OpenINFbot 9c98117
Merge branch 'live' into feat/add-back-handbook-manual-of-style
OpenINFbot 1c27d75
Merge branch 'live' into feat/add-back-handbook-manual-of-style
OpenINFbot a3015dd
Rename handbook-content--g-devdocs-style.html to handbook-content-g-d…
OpenINFbot 3d0072f
Update collections/_docs/handbook/style/people-person-first-language.md
OpenINFbot 8a91a36
Merge branch 'live' into feat/add-back-handbook-manual-of-style
DerekNonGeneric 50bdde6
chore: add a missing file (b&w logogram)
DerekNonGeneric bdbabce
Merge branch 'live' into feat/add-back-handbook-manual-of-style
OpenINFbot e714e94
Merge branch 'live' into feat/add-back-handbook-manual-of-style
OpenINFbot File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,126 @@ | ||||||
--- | ||||||
layout: default | ||||||
--- | ||||||
|
||||||
<main role="main" class="devsite-main-content"> | ||||||
OpenINFbot marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
<div class="devsite-content"> | ||||||
<article class="devsite-article"> | ||||||
{%- if page.editable != false -%} | ||||||
<div class="improve right"> | ||||||
<a href="https://github.com/openinf/.github/edit/HEAD/{{ page.path }}" | ||||||
>Edit</a | ||||||
> | ||||||
</div> | ||||||
{%- endif -%} | ||||||
<h1 class="devsite-page-title">{{ page.title }}</h1> | ||||||
<div class="devsite-article-body clearfix"> | ||||||
<aside id="key-point"> | ||||||
<p><strong>Key Point:</strong> {{ page.key_point }}</p> | ||||||
</aside> | ||||||
DerekNonGeneric marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
{{ content }} | ||||||
</div> | ||||||
</article> | ||||||
<div class="devsite-content-footer nocontent"> | ||||||
<div class="row cc-footer-license"> | ||||||
<div class="license-icons"> | ||||||
<a | ||||||
rel="license nofollow noopener noreferrer" | ||||||
target="_blank" | ||||||
href="https://creativecommons.org/licenses/by/4.0/" | ||||||
title="Creative Commons Attribution 4.0 International license" | ||||||
> | ||||||
<img | ||||||
class="cc-icon-cc" | ||||||
src="https://raw.githubusercontent.com/DerekNonGeneric/loader339/main/doc/img/cc_icon.svg?sanitize=true" | ||||||
OpenINFbot marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
alt="CC logo icon" | ||||||
title="Creative Commons icon" | ||||||
/> | ||||||
<img | ||||||
class="cc-icon-cc-by" | ||||||
src="https://raw.githubusercontent.com/DerekNonGeneric/loader339/main/doc/img/cc-by_icon.svg?sanitize=true" | ||||||
OpenINFbot marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
alt="CC BY icon" | ||||||
title="Attribution icon" | ||||||
/> | ||||||
</a> | ||||||
</div> | ||||||
<aside> | ||||||
<div | ||||||
xmlns:cc="https://creativecommons.org/ns#" | ||||||
about="https://creativecommons.org" | ||||||
> | ||||||
<p dir="auto"> | ||||||
<small | ||||||
>Portions of this document are reproduced from work created and | ||||||
<a | ||||||
target="_blank" | ||||||
href="https://developers.google.com/site-policies" | ||||||
title="Google Developers Site Policies" | ||||||
rel="nofollow noopener noreferrer" | ||||||
>shared by Google</a | ||||||
> | ||||||
and used according to terms described in | ||||||
<a | ||||||
target="_blank" | ||||||
href="https://creativecommons.org/licenses/by/4.0/" | ||||||
title="Creative Commons Attribution 4.0 International license (CC BY 4.0)" | ||||||
rel="license nofollow noopener noreferrer" | ||||||
>CC BY 4.0</a | ||||||
>. For more information, refer to the | ||||||
<a | ||||||
target="_blank" | ||||||
href="{{ page.original_url }}" | ||||||
title="{{ page.original_title }}" | ||||||
rel="nofollow noopener noreferrer" | ||||||
>original source page</a | ||||||
>.</small | ||||||
> | ||||||
</p> | ||||||
</div> | ||||||
</aside> | ||||||
</div> | ||||||
<div class="row cc-footer-license"> | ||||||
<div class="license-icons"> | ||||||
<a | ||||||
rel="license nofollow noopener noreferrer" | ||||||
target="_blank" | ||||||
href="https://creativecommons.org/licenses/by/4.0/" | ||||||
title="Creative Commons Attribution 4.0 International license" | ||||||
> | ||||||
<img | ||||||
class="cc-icon-cc" | ||||||
src="https://raw.githubusercontent.com/DerekNonGeneric/loader339/main/doc/img/cc_icon.svg?sanitize=true" | ||||||
DerekNonGeneric marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
alt="CC logo icon" | ||||||
title="Creative Commons icon" | ||||||
/> | ||||||
<img | ||||||
class="cc-icon-cc-by" | ||||||
src="https://raw.githubusercontent.com/DerekNonGeneric/loader339/main/doc/img/cc-by_icon.svg?sanitize=true" | ||||||
DerekNonGeneric marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
alt="CC BY icon" | ||||||
title="Attribution icon" | ||||||
/> | ||||||
</a> | ||||||
</div> | ||||||
<aside> | ||||||
<div | ||||||
xmlns:cc="https://creativecommons.org/ns#" | ||||||
about="https://creativecommons.org" | ||||||
> | ||||||
<p dir="auto"> | ||||||
<small | ||||||
>Except as otherwise noted, this content is published under | ||||||
<a | ||||||
target="_blank" | ||||||
href="https://creativecommons.org/licenses/by/4.0/" | ||||||
title="Creative Commons Attribution 4.0 International license (CC BY 4.0)" | ||||||
rel="license nofollow noopener noreferrer" | ||||||
>CC BY 4.0</a | ||||||
>.</small | ||||||
> | ||||||
</p> | ||||||
</div> | ||||||
</aside> | ||||||
</div> | ||||||
<p>Last updated {{ "today" | date: "%Y-%m-%d }} UTC.</p> | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
uh oh There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤔i wonder what that looks like; one moment |
||||||
</div> | ||||||
</div> | ||||||
</main> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,112 @@ | ||
# Abbreviations | ||
|
||
**Key Point:** Use standard American abbreviations. Avoid internet slang. | ||
|
||
Abbreviations include acronyms, initialisms, shortened words, and contractions. | ||
|
||
- An acronym is formed from the first letters of words in a phrase, but is | ||
pronounced as if it were a word itself: | ||
- _NATO_ for _North Atlantic Treaty Organization_. | ||
- _scuba_ for _self-contained underwater breathing apparatus_. | ||
- An initialism is also formed from the first letters of words in a phrase, but | ||
each letter is pronounced separately: | ||
- _CIA_ for _Central Intelligence Agency_. | ||
- _FYI_ for _For Your Information_. | ||
- _PR_ for _Public Relations_. | ||
- A shortened word is just part of a word or phrase, sometimes with a period at | ||
the end: | ||
- _Dr._ for _doctor_. | ||
- _etc._ for _et cetera_. | ||
- _min_ for _minutes_. | ||
- _CA_ for _California_. | ||
- [Contractions](contractions.md) are discussed in a separate page of this style | ||
guide. | ||
|
||
There's some overlap among those categories. In particular, some abbreviations | ||
can be either acronyms or initialisms, depending on the speaker's preference; | ||
examples include _FAQ_ and _SQL_. In some cases, the pronunciation determines | ||
[whether to use "a" or "an."](articles.md) | ||
|
||
## Long and short versions of a word | ||
|
||
Some words have a long version and a short version. Examples include: | ||
|
||
- _application_ and _app_ | ||
- _demonstration_ and _demo_ | ||
- _synchronize_ and _sync_ | ||
|
||
The short versions of the words are not abbreviations, and if you use them, you | ||
don't need to put a period after them. | ||
|
||
If you're not sure whether a word is an abbreviation or just a short version of | ||
a longer word, look in our list of [resources](resources.md). If that doesn't | ||
settle the issue, use the speaking test: if you speak the short version as a | ||
word ("This is a demo version of the product"), you can usually treat it as a | ||
word and not an abbreviation. | ||
|
||
## When to spell out a term | ||
|
||
In general, when an abbreviation is likely to be unfamiliar to the audience, | ||
spell out the first mention of the term in the text (not in a heading) and | ||
immediately follow with the abbreviation, in parentheses. For all subsequent | ||
mentions of the abbreviation, use the abbreviation by itself. | ||
|
||
When deciding to spell out a term, consider your audience. If the majority of | ||
your audience is likely to recognize and understand the term, then you don't | ||
need to spell it out. For example, if you're writing documentation for | ||
developers that references an API, you don't need to spell out _application | ||
programming interface_. However, if you're explaining the general concept of an | ||
API to someone with no programming experience, spelling out the abbreviation can | ||
be helpful. | ||
|
||
In some cases, spelling out a term doesn't help the reader understand the term. | ||
For example, writing out _portable document format_ doesn't help the reader | ||
understand what a _PDF_ document is. In those cases, don't spell out the term. | ||
|
||
The following abbreviations rarely need to be spelled out: | ||
|
||
- API | ||
- DVD | ||
- File formats such as PDF or XML | ||
- HTML | ||
- PC | ||
- RAM | ||
- REST | ||
- [Units of measurement](units-of-measure.md) such as _MB_ or _GB_ | ||
- URL | ||
- USB | ||
|
||
## Abbreviations not to use | ||
|
||
Prefer English terms over Latin abbreviations. Don't use "i.e." or "e.g."; | ||
instead, use "that is" or "for example," respectively. One exception: it's | ||
[okay to use "etc." in some circumstances](word-list.md#etc). | ||
|
||
Don't use internet slang abbreviations such as "[tl;dr](word-list.md#tldr)," | ||
"[ymmv](word-list.md#ymmv)," "[RTFM](word-list.md#rtfm)," or others. Write out | ||
what you mean in a non-figurative way. | ||
|
||
Use the most common form of a word. If the full spelled-out word is common and | ||
easily understandable, use that rather than abbreviating. For example, write | ||
"approximately" instead of "approx." | ||
|
||
## Periods with abbreviations | ||
|
||
Follow these guidelines: | ||
|
||
- Don't use periods with acronyms or initialisms. | ||
- Put a period at the end of a shortened word, except for | ||
[date and time](dates-times.md) abbreviations. | ||
- If you write or say an abbreviation as a word (for example, "app" or "sync"), | ||
don't put a period after it. | ||
- Don't use a period with an abbreviation for the name of a country, US state, | ||
or the District of Columbia (DC). | ||
|
||
--- | ||
|
||
<small>Portions of this page are reproduced from work created and | ||
[shared by Google](https://developers.google.com/readme/policies/) and used | ||
according to terms described in the | ||
[Creative Commons 4.0 Attribution License](https://creativecommons.org/licenses/by/4.0/). | ||
For more information, refer to the | ||
[original source page](https://developers.google.com/style/abbreviations).</small> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Double dash file names are not allowed 🚫