cosmos/advocates

Cosmos SDK and Tendermint glossary

Closed this issue · 12 comments

barriebyron commented

Mission: Develop a single source of truth glossary for Tendermint and Cosmos SDK.

Because a published glossary exists, we will focus on improving the published glossary https://cosmos.network/glossary

As of April 2021, Stargate new website is live but this cosmos.network glossary is still v1 and on the design team list. Curiously, the glossary is sourced in two places for two purposes.
See Cyrus comment in this PR

barriebyron commented

@Tosch110 @okwme do we have working glossaries anywhere else?

barriebyron commented

@lovincyrus thanks for this update... Help me understand the status of this glossary. We can rely on this glossary for current and future use? I am digging the tooltips on https://cosmos.network/intro

I think the answer is no, but can we have tooltips from Markdown docs?

lovincyrus commented

We can rely on this glossary for current and future use?

Yes, we can use the list. Now that I think about it, the JSON file was created just so that we could fetch the key value directly without relying the data from Airtable glossary list. They might be identical.

but can we have tooltips from Markdown docs?

Are you suggesting that we should use a markdown file instead of JSON? Which markdown docs are you referring to?

barriebyron commented

@lovincyrus open to ideas! I am in early stages of gathering information and understanding what we have. I want a discoverable Cosmos SDK glossary that is the single source of accurate truth.

lovincyrus commented

You can update the airtable glossary list for the time being since it's easier to maintain than dealing with JSON syntax. 🆗

barriebyron commented

@lovincyrus I didn't see your comment above about the airtable glossary, and instead updated the JSON in tendermint/cosmos-ui#218

  • 👍1
barriebyron commented

UPDATE:

For easy "let's all add terms and definitions" at first I created a collaborative universal glossary sheet but

that effort too got lost in a shuffle. Let's focus only on updating the actual source in the json and airtable

barriebyron commented

Cyrus pointed me to the published glossary https://v1.cosmos.network/glossary

barriebyron commented

Cyrus
old site starts with v1
a lot of people visit the old v1 intro
hover to see definition list

the current definition list is accessed from two places:
/intro
/glossary

right now, this content is not streamlined for the new website. As @lovincyrus explained earlier in this PR, the glossary is sourced from: airtable (legacy, deprecated) and json

Cyrus is going to bump the glossary version and update the glossary to be the new cosmos.network. We don't yet know how the airtable vs json is going to be resolved, it's a work in progress. We do need improved SEO (I didn't even know we had a glossary)

To add new definitions, use a PR for https://github.com/tendermint/cosmos-ui/blob/develop/src/Tooltip/dict.json and ping in #ecodev and get other eyes on it

Cyrus will consolidate into one source and let me know which source.

lovincyrus commented

Update: The v1.cosmos.network/glossary has been bumped in this PR cosmos/v1.cosmos.network#194 ✔️

JSON file: https://github.com/tendermint/cosmos-ui/blob/develop/src/Tooltip/dict.json

Now that we're slowly moving away from cosmos-ui, it makes sense that we relocate the JSON file to elsewhere. The best home for the file is this repo — cosmos/advocates. This omits the need to create another repo. We could also implement a process in which we can introduce/suggest a new definition → review → approve → gets added to the list.

The JSON file will be used in the new cosmos.network and old v1.cosmos.network/glossary. As we're putting in the works in rolling out the new cosmos.network/intro, there is no need to maintain the Airtable Glossary.

Next steps:

  • Cyrus to add the JSON file to this repo