Skip to content

Commit

Permalink
minor tweaks to new glossary build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
cjyabraham committed Feb 18, 2022
1 parent 78ca8ff commit 21923ee
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions spin-new-glossary.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Creating your own glossary

You are welcome to use the code in this repository to spin up your own glossary. Follow these instructions for modifying the site to fit your use-case.
You are welcome to use the code in this repository to spin up your own glossary. Follow these instructions for modifying the code to fit your use-case.

## Get the code

Copy [the glossary code](https://github.com/cncf/glossary/archive/refs/heads/main.zip) into your own repo.

Add [the docsy Hugo theme](https://www.docsy.dev/) as a submodule:
The Glossary site uses the [the docsy Hugo theme](https://www.docsy.dev/). Add the theme code as a submodule of your repo:
```
rm -rf themes/docsy
git submodule add https://github.com/google/docsy.git themes/docsy
Expand All @@ -19,7 +19,7 @@ resources/
node_modules/
```

Complete your local dev setup using [these instructions](https://github.com/cncf/glossary#setting-up-a-local-instance). You should now have a working copy of the Cloud Native Glossary site.
Complete your local dev setup using [these instructions](https://github.com/cncf/glossary#setting-up-a-local-instance). You should now have a local working copy of the Cloud Native Glossary site.

## Design

Expand All @@ -35,7 +35,7 @@ Edit various static copy in the `layouts` folder as needed.

## Content

Replace all content in the `content/en` folder with your own glossary terms. Create a language folder for each of the translation languages you will support. Note that terms will only be listed on the site when `status: Completed`.
Replace all content in the `content/en` folder with your own glossary terms. Create a language folder for each of the translation languages you will support. Note that terms will only be listed on the site when `status: Completed` in the header of the term file.


## Feedback buttons configuration
Expand Down

0 comments on commit 21923ee

Please sign in to comment.