Complete the glossary (an ongoing comprehensive (?) list)

[Blind4Basics]

docs/Glossary

Usage of the present thread

To keep this usable: if you wanna suggest ideas, post a reply to this issue. The maintainer/assignee will then update the present message.

Workflow:

• unchecked word: to add
• checked & crossed out: already added
• checked & not crossed out: just added, needs review

In addition, if you may find from time to time some of the following acronyms:

• W: to rewrite
• H: to review / need help or suggestions
• L: needs links to be added

---

Additional information about how to complete the glossary:

Example

- term: Test Driven Development
  description: A software development process ...
  acronym: TDD
  see: /path/to/a-page/
  links:
    - title: Test-driven Development (Wikipedia)
      url: https://en.wikipedia.org/wiki/Test-driven_development

Structure

type Term {
  id: string;                // (Optional on the user's side) Slugified word. Must be unique. Assigned with `slugify(term)` if unspecified.
  term: string;              // The term in our glossary
  description?: string;      // Description of the term in Markdown. Converted to HTML during build.
  acronym?: string;          // (Optional) acronym form.
  see?: string;              // (Optional) path to a PAGE in our docs. The title will be set automatically
  links?:                    // (Optional) List of external links
     {title: string; url: string}[];
}

The id can be used to link directly to the word

Multiline stuff/descriptions

Use | on the first line

Formatting

Markdowns are supported

Links (see docs guidelines/links)

• Never put a link on the term property (using markdowns)
• links: for external links. Opens the link in a new tab
• see: for internal links, but only to a page, not to an anchor in the page. Opens the link in the current tab.
• To link an entry of the glossary to another one, put the link in the description, using regular markdown. Opens the link in the current tab.

  ...
  - description: See [example tests](/glossary/#example-tests-id)

Traps

Careful with descriptions/strings that contains a colon :...

    description: |
        for katas: blablabla                   // -> WORKS

    description: for katas: blablabla          // -> FAILS

---

State of the art...

• abandoned kata
• active (author)
• L - allies
• approve (kata/translation)
• attempt
• author
• 'best practices" votes
• L - beta (kata/process)
• L - clan(s) (generic link to use when created)
• "clever" votes
• L - collection(s) (generic link to use when created)
• console
• contributor(s)
• dans
• dashboard
• draft (kata)
• duplicate (Kata)
• edit panel
• example tests
• fixed tests
• L - followers
• forfeit (a kata)
• fork (of a solution)
• honor (need to redact/update the honor/rank files)
• inactive (author)
• initial solution
• L - Issue (comment) (link no writen yet)
• L - kata
• L - kata (search) page
• kumite
• kyus
• language version (with eventual remark on ambiguity of the term, i.e. java version of a kata vs. Mono/C# 7/ C# 8 runtimes
• leaderboard (TODO: detailed article ?)
• markdowns
• L - merge conflict (tutorial about translations to write)
• L - mutation of the input (article to write)
• L - output panel
• performances tests
• preloaded (code snippet)
• progress (need to redact/update the honor/rank files)
• L - Question (comment) (link no writen yet)
• random tests
• randomized tests
• rank
• reference solution (ie. solution of the translator/author, at kata/translation creation / to "nuancate" with the one used for random tests)
• reject (translation)
• L - retire/ed (kata, auto-retirement)
• L - sample tests
• satisfaction rating
• sensei
• solution setup (= initial solution)
• spoiler flag
• submission tests
• "submit final"
• L - suggestion label (comments) (link not writen yet)
• TDD
• test cases
• test suite
• L - trainer (kata)
• trainer suggestions
• translation
• translator
• unpublish

[hobovsky]

Is it possible to have the definitions linking/referencing themsleves?

I believe that's how see, and possibly link sections work in the template described here? #9 (comment)

[kazk]

see is used for internal link. Set this to a path to the document and the title will be automatically filled. It'll show up under the description like See Title.

links are used for external links. You need to specify the title and the url.

docs/data/glossary.yml

Lines 28 to 32 in f45064a

	## see: /path/to/a-page/
	## links:
	## - title: Test-driven Development (Wikipedia)
	## url: https://en.wikipedia.org/wiki/Test-driven_development
	## ```

[Blind4Basics]

are some formatting elements possible in the descriptions? (bold, italic, colors, ...?) I guess it's only raw text?
Multiline descriptions, maybe?

[kazk]

Description supports Markdown.

docs/data/glossary.yml

Lines 12 to 13 in f45064a

	## // Description of the term in Markdown. Converted to HTML during build.
	## description?: string;

docs/data/glossary.yml

Lines 62 to 68 in f45064a

	- term: Test Driven Development
	description: |
	> **TODO** Explain. Include why TDD is relevant to Codewars.
	acronym: TDD
	links:
	- title: Test-driven Development - Wikipedia
	url: https://en.wikipedia.org/wiki/Test-driven_development

https://docs.codewars.com/glossary/

[Blind4Basics]

to add/check: #154