Skip to content
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
Merged
Show file tree
Hide file tree
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 Feb 2, 2024
f252836
Restyled by prettier-markdown
restyled-commits Feb 2, 2024
6961430
📖🚮:rm docs re: windows server
DerekNonGeneric Feb 2, 2024
aac6ce0
🏗🚮:rm placeholder .gitkeep file
DerekNonGeneric Feb 2, 2024
946e39a
📖✨: add remaining g-devdocs pages (full-corpus)
DerekNonGeneric Feb 2, 2024
615f586
Restyled by prettier-markdown
restyled-commits Feb 2, 2024
806aaa4
📔✨:restore handbook/styleguide/devdocs conventions
DerekNonGeneric Feb 2, 2024
6526a76
Restyled by prettier-markdown
restyled-commits Feb 2, 2024
77fd894
📖🚮:rm docs re: windows server
DerekNonGeneric Feb 2, 2024
808c7b6
🏗🚮:rm placeholder .gitkeep file
DerekNonGeneric Feb 2, 2024
9d52e96
📖✨: add remaining g-devdocs pages (full-corpus)
DerekNonGeneric Feb 2, 2024
717f412
Restyled by prettier-markdown
restyled-commits Feb 2, 2024
c80cffa
Merge branch 'feat/add-back-handbook-manual-of-style' of https://gith…
DerekNonGeneric Feb 9, 2024
dc20f3e
fix: add people/person-first language
DerekNonGeneric Feb 9, 2024
9a3cb84
📔✨:restore handbook/styleguide/devdocs conventions
DerekNonGeneric Feb 2, 2024
1c2cc5b
📖🚮:rm g-devdocs -- did not go over smoothly
DerekNonGeneric Feb 10, 2024
95534e0
Update _layouts/handbook-content--g-devdocs-style.html
OpenINFbot Feb 19, 2024
0cd4c49
Update _layouts/handbook-content--g-devdocs-style.html
OpenINFbot Feb 19, 2024
1b51d08
Restyled by prettier-markdown
restyled-commits Feb 19, 2024
8dd2a8e
mv windows stuff to drafts
DerekNonGeneric Feb 19, 2024
6200625
Update _layouts/handbook-content--g-devdocs-style.html
OpenINFbot Feb 19, 2024
56454c2
Update _layouts/handbook-content--g-devdocs-style.html
DerekNonGeneric Feb 19, 2024
2379a82
Update _layouts/handbook-content--g-devdocs-style.html
DerekNonGeneric Feb 19, 2024
af27b57
Merge branch 'live' into feat/add-back-handbook-manual-of-style
OpenINFbot Feb 20, 2024
b1cdd48
Merge remote-tracking branch 'upstream/live' into feat/add-back-handb…
DerekNonGeneric Mar 1, 2024
01483b8
Merge branch 'live' into feat/add-back-handbook-manual-of-style
DerekNonGeneric Mar 17, 2024
55eae8f
Update collections/_docs/handbook/style/code-syntax.md
DerekNonGeneric Mar 17, 2024
63b3919
i think we can rm this
DerekNonGeneric Mar 17, 2024
159c1e8
Delete gitkeep.gitkeep
DerekNonGeneric Mar 17, 2024
674462b
add license
DerekNonGeneric Mar 17, 2024
0538a26
add key-point include
DerekNonGeneric Mar 17, 2024
f111f8d
Update _layouts/handbook-content--g-devdocs-style.html
DerekNonGeneric Mar 17, 2024
504f757
slight corrections
DerekNonGeneric Mar 17, 2024
9d33f14
Update collections/_docs/handbook/style/code-syntax.md
DerekNonGeneric Mar 17, 2024
d8be0eb
Merge branch 'live' into feat/add-back-handbook-manual-of-style
DerekNonGeneric Mar 18, 2024
cd3a928
let's get this party started
DerekNonGeneric Mar 18, 2024
70c46e8
we may not repeat headings
DerekNonGeneric Mar 18, 2024
37e53ae
this gnarly; we need runbook guidance
DerekNonGeneric Mar 18, 2024
fb53a5c
here is an example of showing output
DerekNonGeneric Mar 18, 2024
977bad4
Update collections/_docs/handbook/style/code-syntax.md
DerekNonGeneric Mar 18, 2024
5027428
Merge branch 'live' into feat/add-back-handbook-manual-of-style
OpenINFbot Mar 21, 2024
9c98117
Merge branch 'live' into feat/add-back-handbook-manual-of-style
OpenINFbot Mar 21, 2024
1c27d75
Merge branch 'live' into feat/add-back-handbook-manual-of-style
OpenINFbot Apr 4, 2024
a3015dd
Rename handbook-content--g-devdocs-style.html to handbook-content-g-d…
OpenINFbot Apr 5, 2024
3d0072f
Update collections/_docs/handbook/style/people-person-first-language.md
OpenINFbot Apr 5, 2024
8a91a36
Merge branch 'live' into feat/add-back-handbook-manual-of-style
DerekNonGeneric Apr 5, 2024
50bdde6
chore: add a missing file (b&w logogram)
DerekNonGeneric Apr 5, 2024
bdbabce
Merge branch 'live' into feat/add-back-handbook-manual-of-style
OpenINFbot Apr 5, 2024
e714e94
Merge branch 'live' into feat/add-back-handbook-manual-of-style
OpenINFbot Apr 5, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
126 changes: 126 additions & 0 deletions _layouts/handbook-content--g-devdocs-style.html
Copy link
Member Author

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 🚫

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>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<p>Last updated {{ "today" | date: "%Y-%m-%d }} UTC.</p>
<p>Last updated {{ "today" | date: "%Y-%m-%d }} UTC.</p>

uh oh

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔i wonder what that looks like; one moment

</div>
</div>
</main>
112 changes: 112 additions & 0 deletions collections/_docs/handbook/style/abbreviations.md
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>