docs icon indicating copy to clipboard operation
docs copied to clipboard

(#794) Add Jargon Buster page

Open pauby opened this issue 2 years ago • 3 comments

Description Of Changes

Adds the start of a Jargon Buster page.

Motivation and Context

Our documentation uses jargon and acronyms that we need to bust!

Testing

  • [ ] I have previewed these changes using the Docker Container or another method before submitting this pull request.

Change Types Made

  • [ ] Minor documentation fix (typos etc.).
  • [ ] Major documentation change (refactoring, reformatting or adding documentation to existing page).
  • [ ] New documentation page added.
  • [ ] The change I have made should have a video added, and I have raised an issue for this.
    • Issue #

Change Checklist

  • [ ] Requires a change to menu structure (top or left hand side)/
  • [ ] Menu structure has been updated

Related Issue

Fixes #794

pauby avatar Jul 21 '23 14:07 pauby

@gep13 @AdmiringWorm @vexx32 @corbob @st3phhays @Windos @ryanrichter94 @imm0rtalsupp0rt @JPRuskin I've tagged you all in this to review and suggest additions.

Note that this is not in any way complete. I want to get the obvious ones in here and we can update as we go along. Let me know of any, and their definitions and we can add them.

pauby avatar Jul 21 '23 14:07 pauby

I don't feel the word glossary is useful here. A glossary, to me, is a place where I can go and look up all word I don't know that are in the document I'm reading. This is only a page listing jargon and acronyms. It's not a glossary about what a network card is, or a terminal etc.

I feel that jargon buster (which is a commonly used phrase and many documents, technical and not, use them) is a good description of what this is.

pauby avatar Jul 21 '23 16:07 pauby

It has been mentioned elsewhere, but capturing here as well, can we add CLE to the list?

Also, do we want the reciprocal entry for package? In the nupkg entry, we mention that this is a Chocolatey package, so in the package entry, we would mention that this is a file that ends with *.nupkg.

gep13 avatar Jul 24 '23 07:07 gep13