Update docs with glosario usage - #243
Merged
Merged
Conversation
❌ DANGER ❌This pull request has modified workflows that created output. Close this now. |
|
Hi @froggleston, I noticed you've been keeping docs up-to-date, always good to see. I built a small GitHub app for keeping high-level docs (SDK guides, API references, examples, tutorials, etc.) up-to-date whenever you commit changes. No pressure, just thought it might be useful. It's free for OSS: https://github.com/marketplace/deepdocsai |
ErinBecker
reviewed
Aug 6, 2025
ErinBecker
left a comment
ErinBecker
left a comment
Contributor
There was a problem hiding this comment.
Great addition to the documentation @froggleston! I recommend removing the non-Glosario-ified version of the Ecology curriculum text and retaining only the version that includes the Glosario links. Otherwise, minor comments and a spelling fix!
Comment on lines
+1113
to
+1124
| ### Lesson content | ||
|
|
||
| For example, the [datacarpentry/spreadsheet-ecology-lesson](https://github.com/datacarpentry/spreadsheet-ecology-lesson/blob/main/episodes/01-format-data.md) contains the following markdown: | ||
|
|
||
| ``` | ||
| The most common mistake made is treating spreadsheet programs like lab notebooks, that is, relying on context, | ||
| notes in the margin, spatial layout of data and fields to convey information. As humans, we can (usually) interpret | ||
| these things, but computers don't view information the same way, and unless we explain to the computer what | ||
| every single thing means (and that can be hard!), it will not be able to see how our data fits together. | ||
|
|
||
| Using the power of computers, we can manage and analyze data in much more effective and faster ways, but to | ||
| use that power, we have to set up our data for the computer to be able to understand it (and computers are very literal). |
Contributor
There was a problem hiding this comment.
I'm sorry if this is obvious, but I don't understand what this example text is doing here. I expected it to include an example of how Glosario terms are linked, but it doesn't appear to do so.
Contributor
There was a problem hiding this comment.
Ah - I see that the version of this text with Glosario links comes later. I don't know that it adds anything to have the non-Glosario'd version of this text here.
Member
Author
There was a problem hiding this comment.
I was aiming for a "before and after" but if it's clear from the second example with the glosario links included, then I'd be fine removing this!
Co-authored-by: Erin Becker <ebecker@carpentries.org>
Co-authored-by: Erin Becker <ebecker@carpentries.org>
Co-authored-by: Erin Becker <ebecker@carpentries.org>
Co-authored-by: Erin Becker <ebecker@carpentries.org>
github-actions Bot
pushed a commit
that referenced
this pull request
Aug 8, 2025
Auto-generated via `{sandpaper}`
Source : 95fb314
Branch : md-outputs
Author : GitHub Actions <actions@github.com>
Time : 2025-08-08 12:53:40 +0000
Message : markdown source builds
Auto-generated via `{sandpaper}`
Source : 806faa9
Branch : main
Author : Robert Davey <robertdavey@carpentries.org>
Time : 2025-08-08 12:52:11 +0000
Message : Merge pull request #243 from carpentries/frog-glosario-docs-1
Update docs with glosario usage
github-actions Bot
pushed a commit
that referenced
this pull request
Aug 8, 2025
Auto-generated via `{sandpaper}`
Source : 95fb314
Branch : md-outputs
Author : GitHub Actions <actions@github.com>
Time : 2025-08-08 12:53:40 +0000
Message : markdown source builds
Auto-generated via `{sandpaper}`
Source : 806faa9
Branch : main
Author : Robert Davey <robertdavey@carpentries.org>
Time : 2025-08-08 12:52:11 +0000
Message : Merge pull request #243 from carpentries/frog-glosario-docs-1
Update docs with glosario usage
github-actions Bot
pushed a commit
that referenced
this pull request
Aug 12, 2025
Auto-generated via `{sandpaper}`
Source : 95fb314
Branch : md-outputs
Author : GitHub Actions <actions@github.com>
Time : 2025-08-08 12:53:40 +0000
Message : markdown source builds
Auto-generated via `{sandpaper}`
Source : 806faa9
Branch : main
Author : Robert Davey <robertdavey@carpentries.org>
Time : 2025-08-08 12:52:11 +0000
Message : Merge pull request #243 from carpentries/frog-glosario-docs-1
Update docs with glosario usage
github-actions Bot
pushed a commit
that referenced
this pull request
Aug 19, 2025
Auto-generated via `{sandpaper}`
Source : 95fb314
Branch : md-outputs
Author : GitHub Actions <actions@github.com>
Time : 2025-08-08 12:53:40 +0000
Message : markdown source builds
Auto-generated via `{sandpaper}`
Source : 806faa9
Branch : main
Author : Robert Davey <robertdavey@carpentries.org>
Time : 2025-08-08 12:52:11 +0000
Message : Merge pull request #243 from carpentries/frog-glosario-docs-1
Update docs with glosario usage
github-actions Bot
pushed a commit
that referenced
this pull request
Aug 26, 2025
Auto-generated via `{sandpaper}`
Source : 95fb314
Branch : md-outputs
Author : GitHub Actions <actions@github.com>
Time : 2025-08-08 12:53:40 +0000
Message : markdown source builds
Auto-generated via `{sandpaper}`
Source : 806faa9
Branch : main
Author : Robert Davey <robertdavey@carpentries.org>
Time : 2025-08-08 12:52:11 +0000
Message : Merge pull request #243 from carpentries/frog-glosario-docs-1
Update docs with glosario usage
github-actions Bot
pushed a commit
that referenced
this pull request
Sep 2, 2025
Auto-generated via `{sandpaper}`
Source : 95fb314
Branch : md-outputs
Author : GitHub Actions <actions@github.com>
Time : 2025-08-08 12:53:40 +0000
Message : markdown source builds
Auto-generated via `{sandpaper}`
Source : 806faa9
Branch : main
Author : Robert Davey <robertdavey@carpentries.org>
Time : 2025-08-08 12:52:11 +0000
Message : Merge pull request #243 from carpentries/frog-glosario-docs-1
Update docs with glosario usage
github-actions Bot
pushed a commit
that referenced
this pull request
Sep 2, 2025
Auto-generated via `{sandpaper}`
Source : 95fb314
Branch : md-outputs
Author : GitHub Actions <actions@github.com>
Time : 2025-08-08 12:53:40 +0000
Message : markdown source builds
Auto-generated via `{sandpaper}`
Source : 806faa9
Branch : main
Author : Robert Davey <robertdavey@carpentries.org>
Time : 2025-08-08 12:52:11 +0000
Message : Merge pull request #243 from carpentries/frog-glosario-docs-1
Update docs with glosario usage
github-actions Bot
pushed a commit
that referenced
this pull request
Sep 9, 2025
Auto-generated via `{sandpaper}`
Source : 95fb314
Branch : md-outputs
Author : GitHub Actions <actions@github.com>
Time : 2025-08-08 12:53:40 +0000
Message : markdown source builds
Auto-generated via `{sandpaper}`
Source : 806faa9
Branch : main
Author : Robert Davey <robertdavey@carpentries.org>
Time : 2025-08-08 12:52:11 +0000
Message : Merge pull request #243 from carpentries/frog-glosario-docs-1
Update docs with glosario usage
github-actions Bot
pushed a commit
that referenced
this pull request
Sep 16, 2025
Auto-generated via `{sandpaper}`
Source : 95fb314
Branch : md-outputs
Author : GitHub Actions <actions@github.com>
Time : 2025-08-08 12:53:40 +0000
Message : markdown source builds
Auto-generated via `{sandpaper}`
Source : 806faa9
Branch : main
Author : Robert Davey <robertdavey@carpentries.org>
Time : 2025-08-08 12:52:11 +0000
Message : Merge pull request #243 from carpentries/frog-glosario-docs-1
Update docs with glosario usage
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR includes documentation for users of the Workbench who wish to add Glosario references to their lessons, automatically generating links in the lesson Glossary page in the language specified in the config.yaml.