From c5ff655ea078abce6d0653d39783c83d9580ab75 Mon Sep 17 00:00:00 2001 From: Angelique Trusler Date: Fri, 30 Aug 2024 09:59:49 +0200 Subject: [PATCH 1/2] Update README.md --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a51a5891..1114c2b3 100644 --- a/README.md +++ b/README.md @@ -179,13 +179,18 @@ A glossary entry is structured like this: - **Why use Jekyll for the online version?** It is the default for GitHub Pages. -## Collaborators +## Funding and Collaborators SADiLaR is one of the collaborators in the finalisation and expansion of the Glosario Project to African Languages. SADiLaR is a research infrastructure established by the Department of Science and Innovation of the South African government as part of the South African Research Infrastructure Roadmap (SARIR). +To advance data science knowledge and accessibility for our diverse community, we developed Glosario. +We are pleased to share that the Andrew W. Mellon Foundation approved a grant for use +over 12 months (November 2023 through October 2024) to support an upgrade to Glosario, the open-source, +multilingual glossary for computing terms. + ## Credits - Parrot logo by [restocktheshelves](https://www.deviantart.com/restocktheshelves). From 68cf4a3123c9e237da482b501deeeed852f78358 Mon Sep 17 00:00:00 2001 From: Angelique Trusler Date: Thu, 5 Sep 2024 08:29:17 +0200 Subject: [PATCH 2/2] Update README.md --- README.md | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 1114c2b3..a9d4a3d1 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,11 @@ in any of several (human) languages. ## Contributing -You do not need to know any particular programming language to contribute to Glosario: anyone possessing a basic familiarity with the GitHub web interface can get involved! We have prepared a [detailed and accessible guide for contributing](https://docs.google.com/document/d/18oxYd6D9heESqw2gw9cbtxiCfkb4wlxazERFBIDCoeM/edit#heading=h.wsi1psxc3n64), which has been translated into several languages. Contributions are welcome in any language, not only those represented in that document. If you need help with your contribution, feel free to come ask questions on the [#glosario](https://carpentries.slack.com/archives/C01G4HYGAQ6) Slack channel (if you are not a member of The Carpentries Slack you can join by filling [this form](https://slack-invite.carpentries.org/)). +To advance data science knowledge and accessibility for our diverse community, we developed Glosario. You do not need to know any programming language to contribute to Glosario: anyone with a basic familiarity with the GitHub web interface can get involved! We have prepared a [detailed and accessible guide for contributing](https://docs.google.com/document/d/18oxYd6D9heESqw2gw9cbtxiCfkb4wlxazERFBIDCoeM/edit#heading=h.wsi1psxc3n64), which has been translated into several languages. Contributions are welcome in any language, not only those represented in that document. If you need help with your contribution, feel free to come to ask questions on the [#glosario](https://carpentries.slack.com/archives/C01G4HYGAQ6) Slack channel (if you are not a member of The Carpentries Slack you can join by filling [this form](https://slack-invite.carpentries.org/)). ## Lessons -R Markdown and Jupyter notebooks allow authors to place structured metadata in files. +R Markdown and Jupyter Notebooks allow authors to place structured metadata in files. We propose the following metadata (written as YAML): ``` @@ -36,7 +36,7 @@ glossary: - It must introduce a list containing at least one URL. - Those URLs must resolve to glossaries as described in the next section. - Those glossaries are searched in order from first to last to find definitions. -1. The `language` key is required, +1. The `language` key is required and must be a single ISO 639 language code (e.g., `fr` for French). 1. The keys `requires` and `defines` are optional. @@ -49,9 +49,9 @@ glossary: where `GLOSSARY_SITE` is one of the sites listed under the `sources` key and `glossary_key` is an exact match for one of the `defines` keys. -We will provide simple tools to that +We will provide simple tools so that all of the terms listed in a lesson's metadata are linked correctly in its body. -We will also provide shortcuts to make it easy to create correctly-formatted links, +We will also provide shortcuts to make it easy to create correctly-formatted links so that authors can write things like: ``` @@ -136,7 +136,7 @@ A glossary entry is structured like this: 1. She runs a command-line script that: 1. Reads the R Markdown file. 1. Extracts the terms under the `glossary/defines` key. - 1. Searches the body of the document for calls to `gdef(...)`. + 1. Searches the document's body for calls to `gdef(...)`. 1. Checks that every term listed in `glossary/defines` is referenced in the document body, and that every term referenced in the document body is mentioned in `glossary/defines`. @@ -151,7 +151,7 @@ A glossary entry is structured like this: 1. To find prerequisite lessons she can recommend to her students, Beatriz runs a command-line script that: 1. Uses `rmarkdown::yaml_front_matter(filename)` - to reads metadata from all of the lessons she has archived. + to read metadata from all of the lessons she has archived. 1. Lists all of the lessons that state they define the term `regression`. 1. **Summarizing a lesson.** @@ -170,7 +170,7 @@ A glossary entry is structured like this: - **Why not just link to Wikipedia?** We expect that many glossary definitions will do so, - but Wikipedia articles are explanations, not definitions. + However, Wikipedia articles provide explanations, not definitions. - **YAML is hard for people to edit—why not use something else for the glossary file?** Because other formats are just as hard to edit (e.g., JSON) @@ -181,15 +181,13 @@ A glossary entry is structured like this: ## Funding and Collaborators -SADiLaR is one of the collaborators in the finalisation and expansion of the Glosario +[SADiLaR](https://sadilar.org/en/) is one of the collaborators in the finalisation and expansion of the Glosario Project to African Languages. SADiLaR is a research infrastructure established by the Department of Science and Innovation of the South African government as part of the South African Research Infrastructure Roadmap (SARIR). - -To advance data science knowledge and accessibility for our diverse community, we developed Glosario. + We are pleased to share that the Andrew W. Mellon Foundation approved a grant for use -over 12 months (November 2023 through October 2024) to support an upgrade to Glosario, the open-source, -multilingual glossary for computing terms. +over 12 months (November 2023 through October 2024) to support an upgrade to Glosario. ## Credits