Skip to content

Commit

Permalink
New Hugo Site (#229)
Browse files Browse the repository at this point in the history
* moved definitions into /content/en/

* updated all definitions heading structure to work with new site

* moving in Hugo site

* consolidating image directories

* update submodules

* update GitHub repo links

* updated link

* update feedback responses

* added netlify status badge

* configure spellcheck

* added spelling exceptions
  • Loading branch information
cjyabraham authored Sep 29, 2021
1 parent c24394e commit b60ee9d
Show file tree
Hide file tree
Showing 98 changed files with 3,294 additions and 184 deletions.
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@

public/
resources/
node_modules/
tech-doc-hugo

4 changes: 4 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

[submodule "themes/docsy"]
path = themes/docsy
url = https://github.com/google/docsy
3 changes: 3 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
FROM klakegg/hugo:ext-alpine

RUN apk add git
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[![Netlify Status](https://api.netlify.com/api/v1/badges/ba021536-b074-49b8-8981-7a0d19882970/deploy-status)](https://app.netlify.com/sites/cncfglossary/deploys)

# Cloud Native Glossary

The [CNCF](https://www.cncf.io/) Cloud Native Glossary Project is intended to be used as a reference for common terms used when talking about cloud native applications. You can [view and download the current version here](https://github.com/cncf/glossary/blob/main/cloudnative-glossary.pdf).
Expand Down
1 change: 1 addition & 0 deletions assets/icons/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
115 changes: 115 additions & 0 deletions assets/scss/_variables_project.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
/*
Add styles or override variables from the theme here.
*/

$primary: #446CA9;
$link-color: #FF00AA;
$blue: #FF00AA;
$body-color: #2A0054;
$td-enable-google-fonts: false;
$td-sidebar-tree-root-color: $primary;

a:hover {
color: #f0a !important;
text-decoration: underline !important;
}

.navbar-nav a.nav-link:hover {
color: rgba(255,255,255,.5) !important;
text-decoration: none !important;
}

a.tree-root:hover {
color: $primary !important;
text-decoration: none !important;
}

.td-sidebar-nav .td-sidebar-link__page {
color: $body-color !important;
font-weight: 300;
}

.td-sidebar-nav .td-sidebar-link__page:hover {
color: $link-color !important;
text-decoration: none !important;
}

footer a {
color: #fff;
font-weight: 600;
}

footer a:hover {
color: #fff !important;
text-decoration: none !important;
}

h2 a:hover, h3 a:hover {
text-decoration: none !important;
}

h2.feedback--title {
margin-top: 3rem;
}

div.category {
margin: 0 0 .5rem .2rem;
}

.td-page-meta a {
font-weight: 400 !important;
margin-bottom: 0.3rem;
}

i.technology, i.property, i.concept {
-moz-osx-font-smoothing: grayscale;
-webkit-font-smoothing: antialiased;
display: inline-block;
font-style: normal;
font-variant: normal;
text-rendering: auto;
line-height: 1;
font-family: 'Font Awesome 5 Free';
font-weight: 900;
padding-right: 0.5em;
}

i.technology:before {
content: "\f7d9";
}

i.property:before {
content: "\f1ad";
}

i.concept:before {
content: "\f0eb";
}

.td-navbar .navbar-brand svg {
height: 40px !important;
}

footer {
min-height: unset !important;
background-color: $primary;
color: #eee;
}

footer small a {
color: #eee !important;
}

#cncf-logo {
margin: 1rem 0;

}

// temoporary removal of navbar for mobile while we have no elements in it
@media (max-width: 768px) {
.td-navbar .td-navbar-nav-scroll {
display: none
}
}
188 changes: 188 additions & 0 deletions config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,188 @@
baseURL = "/"
title = "CNCF Glossary"

enableRobotsTXT = true

# Hugo allows theme composition (and inheritance). The precedence is from left to right.
theme = ["docsy"]

# Will give values to .Lastmod etc.
enableGitInfo = true

# Language settings
contentDir = "content/en"
defaultContentLanguage = "en"
defaultContentLanguageInSubdir = false
# Useful when translating.
enableMissingTranslationPlaceholders = true

# disableKinds = ["taxonomy", "taxonomyTerm"]

# Highlighting config
pygmentsCodeFences = true
pygmentsUseClasses = false
# Use the new Chroma Go highlighter in Hugo.
pygmentsUseClassic = false
#pygmentsOptions = "linenos=table"
# See https://help.farbox.com/pygments.html
pygmentsStyle = "tango"

# Configure how URLs look like per section.
[permalinks]
blog = "/:section/:year/:month/:day/:slug/"

## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday
[blackfriday]
plainIDAnchors = true
hrefTargetBlank = true
angledQuotes = false
latexDashes = true

# Image processing configuration.
[imaging]
resampleFilter = "CatmullRom"
quality = 75
anchor = "smart"

[services]
[services.googleAnalytics]
# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback].
id = "UA-140890431-2"

# Language configuration

#[languages]
#[languages.en]
#title = "CNCF Glossary"
#description = "Glossary of Cloud Native terms"
#languageName ="English"
## Weight used for sorting.
#weight = 1
#[languages.no]
#title = "CNCF Glossary"
#description = "Docsy er operativsystem for skyen"
#languageName ="Norsk"
#contentDir = "content/no"
#time_format_default = "02.01.2006"
#time_format_blog = "02.01.2006"

[markup]
[markup.goldmark]
[markup.goldmark.renderer]
unsafe = true
[markup.highlight]
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
style = "tango"
# Uncomment if you want your chosen highlight style used for code blocks without a specified language
# guessSyntax = "true"

# Everything below this are Site Params

# Comment out if you don't want the "print entire section" link enabled.
# [outputs]
# section = ["HTML", "print", "RSS"]

[params]
copyright = "The Linux Foundation®"
privacy_policy = "https://www.linuxfoundation.org/privacy"

# First one is picked as the Twitter card image if not set on page.
images = ["images/cncf-icon-color.png"]

# Menu title if your navbar has a versions selector to access old versions of your site.
# This menu appears only if you have at least one [params.versions] set.
version_menu = "Releases"

# Flag used in the "version-banner" partial to decide whether to display a
# banner on every page indicating that this is an archived version of the docs.
# Set this flag to "true" if you want to display the banner.
archived_version = false

# The version number for the version of the docs represented in this doc set.
# Used in the "version-banner" partial to display a version number for the
# current doc set.
version = "0.0"

# A link to latest version of the docs. Used in the "version-banner" partial to
# point people to the main doc site.
url_latest_version = "https://example.com"

# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
github_repo = "https://github.com/cncf/glossary"
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
# github_project_repo = "https://github.com/google/docsy"

# Specify a value here if your content directory is not in your repo's root directory
# github_subdir = ""

# Uncomment this if you have a newer GitHub repo with "main" as the default branch,
# or specify a new value if you want to reference another branch in your GitHub links
github_branch= "main"

# Google Custom Search Engine ID. Remove or comment out to disable search.
# gcs_engine_id = "d72aa9b2712488cc3"

# Enable Algolia DocSearch
algolia_docsearch = false

# Enable Lunr.js offline search
offlineSearch = true

# Enable syntax highlighting and copy buttons on code blocks with Prism
prism_syntax_highlighting = false

# User interface configuration
[params.ui]
# Enable to show the side bar menu in its compact state.
sidebar_menu_compact = true
# Set to true to disable breadcrumb navigation.
breadcrumb_disable = true
# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
sidebar_search_disable = false
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top nav bar
navbar_logo = true
# Set to true to disable the About link in the site footer
footer_about_disable = true

# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
# If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
# add "hide_feedback: true" to the page's front matter.
[params.ui.feedback]
enable = true
# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
yes = 'Thank you! Please <a href="https://github.com/cncf/glossary/issues/new">let us know if you have any suggestions</a>.'
no = 'Thanks for your feedback. Please <a href="https://github.com/cncf/glossary/issues/new">tell us how we can improve</a>.'

# Adds a reading time to the top of each doc.
# If you want this feature, but occasionally need to remove the Reading time from a single page,
# add "hide_readingtime: true" to the page's front matter
[params.ui.readingtime]
enable = false

[params.links]
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
[[params.links.user]]
name = "CNCF Newsletter"
url = "https://www.cncf.io/#newsletter"
icon = "fa fa-envelope"
desc = "Sign up for the CNCF mailing list"
[[params.links.user]]
name ="CNCF Twitter"
url = "https://twitter.com/cloudnativefdn"
icon = "fab fa-twitter"
desc = "Follow us on Twitter to get the latest news!"
[[params.links.user]]
name = "CNCF Slack"
url = "https://slack.cncf.io/"
icon = "fab fa-slack"
desc = "Join the CNCF Slack"
[[params.links.user]]
name = "GitHub"
url = "https://github.com/cncf/glossary"
icon = "fab fa-github"
desc = "Glossary GitHub repo"

[taxonomies]
tag = "tags"
category = "categories"
7 changes: 3 additions & 4 deletions definitions/_TEMPLATE.md → content/en/_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,13 @@ title: Definition Template
status: Feedback Appreciated
category: concept
---
## Definition Template

### What it is
## What it is
A Quick summary of the concept, what it is.

### Problem it Addresses
## Problem it Addresses
A few lines of the problem it's addressing.

### How it Helps
## How it Helps
A few lines of how the thing solves the problem.

Loading

0 comments on commit b60ee9d

Please sign in to comment.