Create an interactive version of the glossary

[caniszczyk]

Ideally we'd create a static website that is an interactive version of the glossary.

The design should be simple, something like https://wpglossary.net (without the ads ;p)

I'd use a hugo+netlify style template, similar to other CNCF websites, pair it with lunr.js maybe to do the search + filtering.

[CathPag]

Sounds good and the example looks great! Each term has its own URL which is the most important thing if we want to optimize for discoverability.

[JasonMorgan]

Relates to issue #15

[CathPag]

Hi @cjyabraham, our goal is to have a website for the glossary live by KubeCon NA and Chris said you'd be able to help (I went ahead and assigned this to you). We are still working on the definitions but we could start working on the static website. Let me know if you want to meet and discuss this. Looking forward to working with you on this!

[cjyabraham]

Hi @CathPag, sounds good. The next couple of weeks are a bit busy for us but we're happy to start the conversation and look to focus on this in the latter half of September and up to Kubecon. I think it's reasonable to expect an MVP to launch prior to Kubecon with refinements to come after that. How does that sound?

I'm adding my colleague @thetwopct here who does most of our front-end development.

[CathPag]

No rush, @cjyabraham . Just ping me on Slack when you're ready to chat.

[cjyabraham]

Some requirements gathered from our call just now:

• similar to https://wpglossary.net/ but have terms on the left
• use the colors of CNCF
• maybe at glossary.cncf.io?
• website would replace the PDF of terms
• include a simple search
• when site loads you’ll have an introduction in the main pane with the same content as the PDF
• each term will have its own permalink
• planning on building a localization effort so needs to be able to support other languages
• we will create a “Glossary” CNCF logo
• make it feel like part of the CNCF ecosystem
• each entry is assigned to a particular category (technology, property, or concept)

[caniszczyk]

My biggest requirement is that it's a static site

…

On Thu, Sep 2, 2021 at 10:15 AM Chris Abraham ***@***.***> wrote: Some requirements gathered from our call just now: - similar to https://wpglossary.net/ but have terms on the left - use the colors of CNCF - maybe at glossary.cncf.io? - website would replace the PDF of terms - include a simple search - when site loads you’ll have an introduction in the main pane with the same content as the PDF - each term will have its own permalink - planning on building a localization effort so needs to be able to support other languages - we will create a “Glossary” CNCF logo - make it feel like part of the CNCF ecosystem — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#155 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAPSIJAPOKVGD2CDLFRHODT76IHPANCNFSM47SSVDLA> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.

-- Cheers, Chris Aniszczyk https://aniszczyk.org

[cjyabraham]

Yep. We'll build it in Hugo so that it's tied in to the GitHub repo of content directly.

[caniszczyk]

ideally the definitions could be in json or some structured format that would just work

…

On Thu, Sep 2, 2021 at 10:54 AM Chris Abraham ***@***.***> wrote: Yep. We'll build it in Hugo so that it's tied in to the GitHub repo of content directly. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#155 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAPSIJOCPEBBFQEXNI74UDT76M2FANCNFSM47SSVDLA> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.

-- Cheers, Chris Aniszczyk https://aniszczyk.org

[cjyabraham]

@caniszczyk do you see this lunching on glossary.cncf.io?

[caniszczyk]

yes, that URL is fine :)

…

On Thu, Sep 2, 2021 at 11:41 AM Chris Abraham ***@***.***> wrote: @caniszczyk <https://github.com/caniszczyk> do you see this lunching on glossary.cncf.io? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#155 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAPSIK2XBQAG3N7XKSH3SDT76SKLANCNFSM47SSVDLA> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.

-- Cheers, Chris Aniszczyk https://aniszczyk.org

[ShreyaTyagi0XD]

yes, that URL is fine :)
…
On Thu, Sep 2, 2021 at 11:41 AM Chris Abraham @.***> wrote: @caniszczyk https://github.com/caniszczyk do you see this lunching on glossary.cncf.io? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#155 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAPSIK2XBQAG3N7XKSH3SDT76SKLANCNFSM47SSVDLA . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.
-- Cheers, Chris Aniszczyk https://aniszczyk.org

Can I work on the design of the website?

[CathPag]

Thanks for offering, @ShreyaTyagi0XD, but @cjyabraham is already working on this. The entire website process will be handled by the CNCF team directly.