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

Add a glossary to the documentation #650

Open
simonw opened this issue Dec 9, 2019 · 3 comments
Open

Add a glossary to the documentation #650

simonw opened this issue Dec 9, 2019 · 3 comments

Comments

@simonw
Copy link
Owner

simonw commented Dec 9, 2019

Call it glossary.rst - it can use a definition list something like this:

.. _glossary:

Glossary
========

Term
  A definition of the term.

Another term
  Another definition.
@simonw
Copy link
Owner Author

simonw commented Dec 9, 2019

In the future I may write a script which extracts the terms from this document into a separate database table.

@simonw
Copy link
Owner Author

simonw commented Mar 22, 2020

Ansible has a good example of a glossary: https://docs.ansible.com/ansible/latest/reference_appendices/glossary.html

@simonw
Copy link
Owner Author

simonw commented Jan 13, 2022

Challenge: explain the difference between view as in SQL view, and view as in the code that serves TableView / DatabaseView etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant