Add basic content to site (#3)

* Content and config of the demo website

This commit contains the website used for internal demos. This is the final state of a local repository.

* Make it build

* Fix image paths on the tour page

* [main] Updates the type of the features section

So they are displayed in a row

* [main] fix display of subproject cards

TODO: add css to center the images

* [docs] Image fixes

* [docs] Delete manual on-page tocs

* [docs] Don't use level-1 headings

* [docs] Link fixes

* Typo fixes

* Remove obsolete code

* [docs] link fix

* Merge conflicting hugo config files into a single file

---------

Co-authored-by: Daniel Toth (datoth) <[email protected]>

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "themes/docsy"]
+	path = themes/docsy
+	url = https://github.com/google/docsy.git

assets/scss/_styles_project.scss

@@ -0,0 +1,51 @@
+/*
+
+Nothing defined here. The Hugo project that uses this theme can override Bootstrap by adding a file to:
+
+assets/scss/_styles_project.scss
+
+*/
+@import "tocbot";
+
+.warning-block {
+    border-left: 6px solid red;
+    background: #FFFFFF;
+    padding: 16px;
+  }
+
+/*
+h3[class*="type-"]::before {
+  background-color: $primary;
+  content: "type";
+  font-size: 14px;
+  line-height: 22px;
+  padding: 3px 6px;
+  text-transform: uppercase;
+}
+*/
+
+.property-optional::after {
+  content: "optional";
+  background-color: $secondary;
+  font-size: 14px;
+  line-height: 22px;
+  padding: 3px 6px;
+  text-transform: uppercase;
+}
+.property-required::after {
+  content: "required";
+  background-color: $primary;
+  color: white;
+  font-size: 14px;
+  line-height: 22px;
+  padding: 3px 6px;
+  text-transform: uppercase;
+}
+
+.main-lead {
+  line-height: 1.5;
+}
+
+.td-main * .td-card-group {
+  max-width: 100%;
+}

assets/scss/_variables_project.scss

@@ -1,6 +1,2 @@
-/*
-
-Add styles or override variables from the theme here.
-
-*/
-
+$navbar-dark-color: white; // Set navbar text to white to increase contrast
+$blue: #2263BF !default; // Override breadcrumb and sidebar text color to increase contrast

config/_default/config.toml

@@ -0,0 +1,258 @@
+baseURL = "/"
+title = "OpenClarity"
+
+# Language settings
+languageCode = "en-us"
+contentDir = "content"
+defaultContentLanguage = "en"
+defaultContentLanguageInSubdir = false
+# Useful when translating.
+enableMissingTranslationPlaceholders = true
+
+enableRobotsTXT = true
+
+# Will give values to .Lastmod etc.
+enableGitInfo = true
+
+# Comment out to enable taxonomies in Docsy
+# disableKinds = ["taxonomy", "taxonomyTerm"]
+
+# You can add your own taxonomies
+[taxonomies]
+tag = "tags"
+category = "categories"
+
+[params.taxonomy]
+# set taxonomyCloud = [] to hide taxonomy clouds
+taxonomyCloud = ["tags", "categories"]
+
+# If used, must have same length as taxonomyCloud
+taxonomyCloudTitle = ["Tag Cloud", "Categories"]
+
+# set taxonomyPageHeader = [] to hide taxonomies on the page headers
+taxonomyPageHeader = ["tags", "categories"]
+
+# Language configuration
+
+[languages]
+[languages.en]
+languageName ="English"
+# Weight used for sorting.
+weight = 1
+[languages.en.params]
+title = "OpenClarity"
+description = "OpenClarity is a suite of open source tools for cloud native security and observability — VMClarity, KubeClarity, and APIClarity."
+
+[outputs]
+    home = ["HTML", "print"]
+    # Enable print this section menu item
+    section = [ "HTML", "print" ]
+
+[social]
+# Used as twitter:site in page metadata
+twitter = "ciscoemerge"
+
+[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"
+
+[params]
+
+  email = "mailto:[email protected]"
+
+  copyright = "The OpenClarity Authors"
+
+  relativeURLs = true
+
+  # Add project name to the header
+  project_name = "OpenClarity"
+  product_name = "OpenClarity"
+
+  latest_version = "0.5.0" # Used in some installation commands
+  latest_operator_version = "0.5.0"
+
+  ###############################################################################
+  # Docsy-theme specific config customizations
+  ###############################################################################
+
+  # 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 = "4.0.0"
+  version_menu_canonicallinks = true
+
+  # 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 = "/"
+
+  # Repository configuration (URLs for in-page links to opening issues and suggesting changes)
+  github_repo = "https://github.com/openclarity/openclarity.io"
+  # An optional link to a related project repo. For example, the sibling repository where your product code lives.
+  github_project_repo = "https://github.com/openclarity"
+
+  # Specify a value here if your content directory is not in your repo's root directory
+  # github_subdir = ""
+
+  # Uncomment this if your GitHub repo does not have "main" as the default branch,
+  # or specify a new value if you want to reference another branch in your GitHub links
+  github_branch= "main"
+
+
+  # Enable Lunr.js offline search
+  offlineSearch = true
+
+  # Add CTA partial to navbar
+  navbar_cta = true
+
+  #####
+  # Code highlighting
+  #####
+  # 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 = "coy"
+  # Enable syntax highlighting and copy buttons on code blocks with Prism
+  prism_syntax_highlighting = true
+
+  # User interface configuration
+  [params.ui]
+  #  Set to true to disable breadcrumb navigation.
+  breadcrumb_disable = false
+  # Set to true to disable the About link in the site footer
+  footer_about_disable = false
+  # Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar
+  navbar_logo = true
+  # Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage.
+  navbar_translucent_over_cover_disable = false
+  # Enable to show the side bar menu in its compact state.
+  #sidebar_menu_compact = false
+  # Enable to make the side bar menu foldable.
+  sidebar_menu_foldable = 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
+
+  [params.jstoc]
+  enable = true
+
+  [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 = "Community forum"
+  #  url = "https://community.cisco.com/t5/application-networking-and/bd-p/dev-app-networking"
+  #  icon = "fa fa-envelope"
+  #  desc = "Discussion and help from your fellow users"
+  #[[params.links.user]]
+  #  name ="Twitter"
+  #  url = "https://twitter.com/ciscoemerge"
+  #  icon = "fab fa-twitter"
+  #  desc = "Follow us on Twitter to get the latest news!"
+  #[[params.links.user]]
+  #  name = "Linkedin"
+  #  url = "https://linkedin.com/cisco-emerging-technologies-and-incubation"
+  #  icon = "fab fa-linkedin"
+  #  desc = "Follow us on Twitter to get the latest news!"
+  # Developer relevant links. These will show up on right side of footer and in the community page if you have one.
+  [[params.links.developer]]
+    name = "GitHub"
+    url = "https://github.com/openclarity"
+    icon = "fab fa-github"
+    desc = "Get involved with OpenClarity development"
+  [[params.links.developer]]
+    name = "Slack"
+    url = "https://outshift.slack.com/messages/vmclarity"
+    icon = "fab fa-slack"
+    desc = "Chat with the project developers"
+  #[[params.links.developer]]
+  #  name = "Developer mailing list"
+  #  url = "https://example.org/mail"
+  #  icon = "fa fa-envelope"
+  #  desc = "Discuss development issues around the project"
+
+###############################################################################
+# Hugo - Top-level navigation (horizontal)
+###############################################################################
+[menu]
+  [[menu.main]]
+    name = "Project page"
+    weight = -110
+    pre = "<i class='fab fa-github pr-2'></i>"
+    url = "https://github.com/openclarity"
+  [[menu.main]]
+    name = "Documentation"
+    weight = -100
+    pre = "<i class='fas fa-book pr-2'></i>"
+    url = "/docs/"
+  [[menu.main]]
+    name = "Blog"
+    weight = 140
+    pre = "<i class='fas fa-blog pr-2'></i>"
+    url = "/blog/"
+  [[menu.main]]
+    name = "Community"
+    url = "https://outshift.slack.com/messages/vmclarity"
+    pre = "<i class='fab fa-slack pr-2'></i>"
+    weight = 150
+
+###############################################################################
+# Misc customizations
+###############################################################################
+
+enableRobotsTXT = true
+
+enableGitInfo = true
+
+# Image processing configuration.
+[imaging]
+resampleFilter = "CatmullRom"
+quality = 75
+anchor = "smart"
+
+[minify]
+  minifyOutput = true
+  disableJSON = true
+  [minify.tdewolff]
+    [minify.tdewolff.html]
+    keepQuotes = true
+    keepWhitespace = true
+
+[sitemap]
+  ChangeFreq = "daily"
+  Priority = "1"
+
+[security]
+  [security.funcs]
+    getenv = ['^HUGO_', 'PWD', '^DOC_', 'ENVIRONMENT']
+
+[privacy]
+  [privacy.googleAnalytics]
+    respectDoNotTrack = true
+
+# hugo module configuration
+
+[module]
+  # uncomment line below for temporary local development of module
+  # replacements = "github.com/google/docsy -> ../../docsy"
+  [module.hugoVersion]
+    extended = true
+    min = "0.110.0"
+  [[module.imports]]
+    path = "github.com/google/docsy"
+    disable = false
+  [[module.imports]]
+    path = "github.com/google/docsy/dependencies"
+    disable = false

config/production/config.toml

@@ -0,0 +1,12 @@
+baseurl = "https://openclarity.io/"
+buildDrafts = false
+#googleAnalytics = "G-FIXME"
+
+[services]
+[services.googleAnalytics]
+# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback].
+#id = "G-FIXME"
+
+[params]
+
+url_latest_version = "https://openclarity.io/"