Merge pull request #2 from robotframework/main

Implement GlossaryTerm React component per reviewer feedback

Author: solzlivinglife

.github/.workflows/pages.yml

@@ -50,7 +50,7 @@ LO-2.5.2.3,(K1),Recall the concept of keywords with embedded arguments used in B
 LO-2.5.2.4,(K1),"Recall how ""Positional or Named Arguments"" are marked in the documentation and their use case.",,,
 LO-2.5.2.5,(K1),"Recall how ""Variable Number of Positional Arguments"" are marked in the documentation and their use case.",,,
 LO-2.5.2.6,(K1),"Recall what properties ""Named-Only Arguments"" have and how they are documented.",,,
-LO-2.5.2.7,(K1),Recall how free named arguments are marked in documentation.,,,
+LO-2.5.2.7,(K1),"Recall how ""Free Named Arguments"" are marked in documentation.",,,
 LO-2.5.2.8,(K2),Understand the concept of argument types and automatic type conversion.,,,
 LO-2.5.2.9,(K2),Understand the concept of return type hints.,,,
 LO-2.5.3,(K2),Understand how to read keyword documentation and how to interpret the examples.,,,

Glossary_wip.md

@@ -96,7 +96,7 @@
 - [`2.5.1 Documented Keyword Information`](website/docs/chapter-02/05_keyword_interface.md#251-documented-keyword-information)
   - LO-2.5.1 (K1) Recall the information that can be found in a keyword documentation.
   - [`2.5.1.1 Example Keyword `Should Be Equal``](website/docs/chapter-02/05_keyword_interface.md#2511-example-keyword-should-be-equal)
-  - [`2.5.1.2 Example Keyword `Run Process``](website/docs/chapter-02/05_keyword_interface.md#2512-example-keyword-run-process)
+  - [`2.5.1.2 Example Keyword `Set To Dictionary``](website/docs/chapter-02/05_keyword_interface.md#2512-example-keyword-set-to-dictionary)
   - [`2.5.1.3 Example Keyword `Get Regexp Matches``](website/docs/chapter-02/05_keyword_interface.md#2513-example-keyword-get-regexp-matches)
 - [`2.5.2 Keyword Arguments`](website/docs/chapter-02/05_keyword_interface.md#252-keyword-arguments)
   - LO-2.5.2 (K2) Understand the difference between argument kinds.
@@ -113,7 +113,7 @@
   - [`2.5.2.6 Named-Only Arguments`](website/docs/chapter-02/05_keyword_interface.md#2526-named-only-arguments)
     - LO-2.5.2.6 (K1) Recall what properties "Named-Only Arguments" have and how they are documented.
   - [`2.5.2.7 Free Named Arguments`](website/docs/chapter-02/05_keyword_interface.md#2527-free-named-arguments)
-    - LO-2.5.2.7 (K1) Recall how free named arguments are marked in documentation.
+    - LO-2.5.2.7 (K1) Recall how "Free Named Arguments" are marked in documentation.
   - [`2.5.2.8 Argument Types`](website/docs/chapter-02/05_keyword_interface.md#2528-argument-types)
     - LO-2.5.2.8 (K2) Understand the concept of argument types and automatic type conversion.
   - [`2.5.2.9 Return Types`](website/docs/chapter-02/05_keyword_interface.md#2529-return-types)

LOs.csv

@@ -8,6 +8,16 @@
 .docusaurus
 .cache-loader
 
+# Build artifacts - TypeScript compiled JS files from TS sources
+docusaurus.config.js
+sidebars.js
+/src/components/**/*.js
+/src/pages/**/*.js
+/src/theme/**/*.js
+# Keep these JS files that are source files, not build artifacts:
+!/src/components/Quiz/quizPrebuild.js
+!/src/remark/*.js
+
 # Misc
 .DS_Store
 .env.local

README.md

@@ -5,21 +5,27 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati
 ### Installation
 
 ```
-$ yarn
+$ npm install
+```
+
+For reproducible installs in CI, use:
+
+```
+$ npm ci
 ```
 
 ### Local Development
 
 ```
-$ yarn start
+$ npm run start
 ```
 
 This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
 
 ### Build
 
 ```
-$ yarn build
+$ npm run build
 ```
 
 This command generates static content into the `build` directory and can be served using any static contents hosting service.
@@ -29,13 +35,13 @@ This command generates static content into the `build` directory and can be serv
 Using SSH:
 
 ```
-$ USE_SSH=true yarn deploy
+$ USE_SSH=true npm run deploy
 ```
 
 Not using SSH:
 
 ```
-$ GIT_USER=<Your GitHub username> yarn deploy
+$ GIT_USER=<Your GitHub username> npm run deploy
 ```
 
 If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

website/.gitignore

@@ -39,7 +39,7 @@ When executing or debugging tests|tasks, the editor supports the execution layer
 When writing keywords in e.g. Python for keyword libraries, the editor supports the adaptation layer.
 Therefore also other additional extensions of Robot Framework can be categorized into these layers.
 
-<!-- TODO: add a graphic here -->
+{/* TODO: add a graphic here */}
 
 ## 1.2.2 What is Robot Framework & What It Is Not
 

website/README.md

@@ -16,7 +16,7 @@ While **Keyword-Driven Testing (KDT)** and **Behavior-Driven Development (BDD)**
 
 Both styles can be mixed, even within the same test or task, but it is strongly recommended to have separate styles for separate purposes and not mix them within the same body.
 One practical solution would be to define acceptance test cases that cover users' expectations in a declarative *Behavior-Driven Style*, while using keywords that are implemented in an imperative *Keyword-Driven style*.
-Further system level test cases, that are not covering acceptance criteria could be written in a *Keyword-Driven style*.
+Further system level :term[test cases]{term="Test Case"}, that are not covering acceptance criteria could be written in a *Keyword-Driven style*.
 
 The approach of both styles is different in that way,
 that the *Behavior-Driven Style* is a **declarative** specification,

website/docs/chapter-01/02_architecture.md

@@ -194,7 +194,7 @@ A suite file must contain either a `*** Test Cases ***` or a `*** Tasks ***` sec
 
 See [2.6 Writing Test|Task and Calling Keywords](chapter-02/06_writing_test.md) for more information about the `*** Test Cases ***` or `*** Tasks ***` section.
 
-<!-- TODO maybe more references to Test Setup/Teardown or Documentation? -->
+{/* TODO maybe more references to Test Setup/Teardown or Documentation? */}
 
 ### 2.1.2.4 Introduction to `*** Keywords ***` Section
 

website/docs/chapter-01/04_styles.md

@@ -1,11 +1,8 @@
 
 # 2.2 Basic Suite File Syntax
 
-<!--
-TODO:
-I think this section needs a bit more structure and we should introduce the concept of "settings" like [Documentation] already here and reference to Chapter 4.
+{/* TODO: I think this section needs a bit more structure and we should introduce the concept of "settings" like [Documentation] already here and reference to Chapter 4.*/}
 
- -->
 
 ::::lo[Learning Objectives]