https://github.com/spack/spackpedia
An encycopedia of spack terms, some core to the software, and others core to our humor and hearts.
https://github.com/spack/spackpedia
Last synced: 11 months ago
JSON representation
An encycopedia of spack terms, some core to the software, and others core to our humor and hearts.
- Host: GitHub
- URL: https://github.com/spack/spackpedia
- Owner: spack
- Created: 2021-08-22T03:04:57.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-08-22T19:45:15.000Z (over 4 years ago)
- Last Synced: 2025-04-21T00:28:57.504Z (about 1 year ago)
- Language: CSS
- Homepage: https://spack.github.io/spackpedia/
- Size: 934 KB
- Stars: 3
- Watchers: 6
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Spack Encyclopedia (spackpedia)
[](https://github.com/spack/spackpedia/actions?query=branch%3Amain+workflow%3ACI)
## What is the Spack Encyclopedia?
Have you ever made up a special, spack specific term, like a spackage?
Or have you wondered about specific terms in the spack jargon like "spec" or "build cache?"
This is a place you can read about each one, or you can more generally write them all
down in one place! Some terms are for fun like "spackage" and some are considered
spack terminology like "spec." With the spack encyclopedia we can have a little fun, and celebrate
spack!
## How do I contribute?
There are so many ways to contribute!
1. Update an existing term definition, related terms, or usage.
2. Add an image to an existing term without one (memes are the best!)
3. Add a completely new term.
4. Update some design or functionality of the site (advanced)
You can edit or add a new term by editing the [_data/terms.yml](_data/terms.yml)
file. If you want to contribute but need some help, or just want to share content
and ask one of the maintainers here to add it, please don't hesitate to [open an issue](https://github.com/spack/spackpedia/issues).
We're here to help!
### 1. Adding or Updating a Term
Minimally, you should add:
```yaml
- name: spackage
definition: A spack package.
usage: I want to use this cool new software module, but there isn't a spackage for it.
core: false
```
Where "core" indicates if the term is a core spack (non-made-up) term like "spec," in which
case you should put "true." Otherwise, for made-up or fun terms, put "false" as shown above.
For the name of the term, to keep things simple to parse, if there are multiple words (e.g., build cache)
just include them with a hyphen. And optionally you can also add an image or url. The url will be an external link, and the image
is shown on the term's page.
```yaml
url: https://spack.github.io/packages
image: term-image.png
```
The image should be located in [assets/img/terms](assets/img/terms), and make sure if you use any
quotes, you use single quotes `'` and not double `"`. This will be tested to make sure you don't miss anything!
If you have any questions, or want to request more docs are written here, please don't hesitate to [open an issue](https://www.github.com/spack/spackpedia/issues).