Add automated glossary linking with complete term coverage#88
Add automated glossary linking with complete term coverage#88solzlivinglife wants to merge 1 commit into
Conversation
|
🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-88.surge.sh/robotframework-RFCP-syllabus/ |
|
|
||
| :::: | ||
|
|
||
| All arguments that are defined after a :term[Variable Number of Positional Arguments] (`*varargs`) are :term[Named-Only Arguments]{term="Named-Only Argument"}. |
There was a problem hiding this comment.
Here in this line is the correct way how a link should be build up. So not a regular Markdown link, but :term[singular or plural seen in the doc]{term="syllabus term"}
That would then look like: 
solzlivinglife
force-pushed
the
glossary-links-fixed
branch
from
cbec970 to
2a4cb0d
Compare
|
🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-88.surge.sh/robotframework-RFCP-syllabus/ |
|
There should not happen any renumbering of Learning Objectives and please do not use the glossary technique in Learning Objectives. |
|
In the glossary it not says everywhere However, that should be: This is part of a docusaurus plugin, which makes for the right formatting |
solzlivinglife
force-pushed
the
glossary-links-fixed
branch
3 times, most recently
from
535f752 to
1d20cd1
Compare
|
@Snooz82 and @leeuwe, I've updated the PR to use the :term[] directive format as requested. -: Switched from custom component to Docusaurus :term[] directive Note on CI failure: |
|
|
||
| If a **relative path** is given, the resource file or library is searched for relative to the data file that is importing it and then relative to the Python *module search path*. | ||
| This *module search path* is defined by the Python interpreter that executes Robot Framework and can be influenced by the environment variable `PYTHONPATH` or by using the CLI-Argument `--pythonpath` when executing `robot`. | ||
| This *module search path* is defined by the Python interpreter that executes Robot Framework and can be influenced by the environment :term[variable]{term="Variable"} `PYTHONPATH` or by using the :term[CLI]{term="Command Line Interface"}-:term[Argument]{term="Argument"} `--pythonpath` when executing `robot`. |
There was a problem hiding this comment.
CLI-Argument should be seen as one token, so the - should be ignored I think
There was a problem hiding this comment.
@Snooz82 I don't understand why the pipeline is failing this time, and I could really use your assistance in that matter
- Changed glossary_linker.py to output :term[] format instead of <GlossaryTerm> - Removed GlossaryTerm React component and CSS (no longer needed) - Added learning_objectives.md to exclusion list - ~210 glossary links using Docusaurus :term[] directive - Rebased on latest upstream/main Per reviewer feedback, using existing Docusaurus :term[] plugin instead of custom component.
GerwinLaagland
force-pushed
the
glossary-links-fixed
branch
from
1d20cd1 to
f2ab7ed
Compare
3 participants
Features: