Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Glossary of technical terms #141

Open
kierisi opened this issue Dec 28, 2023 · 4 comments
Open

Glossary of technical terms #141

kierisi opened this issue Dec 28, 2023 · 4 comments
Labels
documentation Improvements or additions to documentation sprintable

Comments

@kierisi
Copy link
Contributor

kierisi commented Dec 28, 2023

From the Bug Bash conversation with @lwasser:

* [jupyterbook has one!](https://jupyterbook.org/en/stable/reference/glossary.html)
* https://raw.githubusercontent.com/executablebooks/jupyter-book/master/docs/reference/glossary.md

and it looks like there is a sphinx [glossary directive](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#glossary) we can employ as well.

we could literally work on it at any time and perhaps the first step is just a list of terms in a hackmd or something that we can work on fleshing out with the community?
@lwasser
Copy link
Member

lwasser commented Dec 28, 2023

Thank you!! so the steps here would be

  • First we create a list of terms that we want to define - perhaps in a hackmd file linked to this issue?
  • then we create definitions for those terms
  • Then we literally just add it to the sphinx book within a glossary directive.

it should be that simple.

@willingc willingc added documentation Improvements or additions to documentation sprintable labels Jan 11, 2024
@lwasser
Copy link
Member

lwasser commented Mar 21, 2024

i'm going to close the open pr which is a demo of how this can work and just add the link here to that pr when we begin to work on this issue. this actually would be a really great thing to work on in sprints this summer. @kierisi maybe you could join us remotely in the sprints at pycon and scipy?! OR maybe we host a sprint for pyOpenSci?

@kierisi
Copy link
Contributor Author

kierisi commented Mar 21, 2024

@lwasser I really love the idea of hosting a sprint for pyOpenSci. I'll put something in asana and add you as a collaborator - could be perfect to knock out this fall!

@lwasser
Copy link
Member

lwasser commented Mar 21, 2024

Ok yay! We could even have review sprints Jesse!! Following the content you are creating !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation sprintable
Projects
None yet
Development

No branches or pull requests

3 participants