Skip to content

Commit b097c65

Browse files
JimBugwadiaJimBugwadia
committed
initial site
Signed-off-by: Jim Bugwadia <jim@nirmata.com>
1 parent 740a5b4 commit b097c65

File tree

21 files changed

+444
-2
lines changed

21 files changed

+444
-2
lines changed

‎.github/workflows/deploy.yml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
with:
15+
submodules: recursive
16+
fetch-depth: 0
17+
18+
- name: Setup Hugo
19+
uses: peaceiris/actions-hugo@v2
20+
with:
21+
hugo-version: 'latest'
22+
extended: true
23+
24+
- name: Setup Node
25+
uses: actions/setup-node@v3
26+
with:
27+
node-version: '16'
28+
cache: 'npm'
29+
30+
- name: Install dependencies
31+
run: npm ci
32+
33+
- name: Build
34+
run: hugo --minify
35+
36+
- name: Deploy
37+
uses: peaceiris/actions-gh-pages@v3
38+
if: github.ref == 'refs/heads/main'
39+
with:
40+
github_token: ${{ secrets.GITHUB_TOKEN }}
41+
publish_dir: ./public

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
public/
2+
resources/
3+
node_modules/
4+
.hugo_build.lock

‎.gitmodules‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "themes/docsy"]
2+
path = themes/docsy
3+
url = https://github.com/google/docsy.git

‎README.md‎

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,42 @@
1-
# website
2-
OpenReports WebSite
1+
# OpenReports
2+
3+
This repository contains the documentation website for OpenReports, built using [Hugo](https://gohugo.io/) with the [Docsy](https://www.docsy.dev/) theme.
4+
5+
## Prerequisites
6+
7+
- [Hugo Extended](https://gohugo.io/getting-started/installing/) (version 0.110.0 or later)
8+
- [Node.js](https://nodejs.org/) (version 16.x or later)
9+
- [Git](https://git-scm.com/)
10+
11+
## Local Development
12+
13+
1. Clone this repository:
14+
```bash
15+
git clone [your-repo-url]
16+
cd openreports-docs
17+
```
18+
19+
2. Get the theme submodules:
20+
```bash
21+
git submodule update --init --recursive
22+
```
23+
24+
3. Install npm dependencies:
25+
```bash
26+
npm install
27+
```
28+
29+
4. Start the local development server:
30+
```bash
31+
hugo server
32+
```
33+
34+
The site will be available at http://localhost:1313/
35+
36+
## Contributing
37+
38+
Please see our [Contributing Guide](CONTRIBUTING.md) for details on how to contribute to the documentation.
39+
40+
## License
41+
42+
[Add your license information here]

‎config/_default/hugo.toml‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
baseURL = "/"
2+
languageCode = "en-us"
3+
title = "OpenReports"
4+
# theme = ["docsy"]
5+
description = "Standardized Reporting For Kubernetes"
6+
Paginate = 20
7+
8+
enableRobotsTXT = true
9+
10+
# Will give values to .Lastmod etc.
11+
enableGitInfo = true
12+
13+
# Language settings
14+
contentDir = "content/en"
15+
defaultContentLanguage = "en"
16+
defaultContentLanguageInSubdir = false
17+
# Useful when translating.
18+
enableMissingTranslationPlaceholders = true
19+
20+
disableKinds = ["taxonomy"]
21+
22+
ignoreFiles = [ "^OWNERS$", "README[-]+[a-z]*\\.md", "^node_modules$"]
23+
24+
timeout = "30s"
25+
26+
# Norwegian ("no") is sometimes but not currently used for testing.
27+
# Hindi is disabled because it's currently in development.
28+
disableLanguages = ["hi", "no"]
29+
30+
[frontmatter]
31+
date = ["date", ":filename", "publishDate", "lastmod"]
32+
33+
# Configure how URLs look like per section.
34+
[permalinks]
35+
blog = "/:section/:year/:month/:day/:slug/"
36+
37+
# Image processing configuration.
38+
[imaging]
39+
resampleFilter = "CatmullRom"
40+
quality = 75
41+
anchor = "Smart"
42+
43+
# First one is picked as the Twitter card image if not set on page.
44+
# images = ["images/project-illustration.png"]
45+
46+
[services]
47+
[services.googleAnalytics]
48+
# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback].
49+
id = ""
50+
51+
[outputs]
52+
home = ["HTML","RSS","JSON"]
53+
54+
# register docsytheme as hugo module
55+
[module]
56+
# uncomment line below for temporary local development of module
57+
# needs hugo v0.109.0 or higher and go 1.18 or higher
58+
# workspace = "hugo.work"
59+
[module.hugoVersion]
60+
extended = true
61+
min = "0.109.0"
62+
[[module.imports]]
63+
path = "github.com/google/docsy"
64+
disable = false
65+
[[module.imports]]
66+
path = "github.com/google/docsy/dependencies"
67+
disable = false

‎config/_default/languages.toml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
[en]
2+
title = "OpenReports"
3+
languageName ="English"
4+
# Weight used for sorting.
5+
weight = 1
6+
[en.params]
7+
description = "Standardized Reporting For Kubernetes"

‎config/_default/markup.toml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## Configuration for goldmark markdown parser: https://gohugo.io/getting-started/configuration-markup#goldmark
2+
[goldmark]
3+
[goldmark.renderer]
4+
unsafe = true
5+
[goldmark.renderHooks]
6+
[goldmark.renderHooks.link]
7+
enableDefault = true
8+
# [goldmark.renderHooks.image]
9+
# enableDefault = true
10+
11+
[highlight]
12+
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
13+
style = "tango"
14+
codeFences = true
15+
guessSyntax = false
16+
hl_Lines = ""
17+
lineNoStart = 1
18+
lineNos = true
19+
lineNumbersInTable = false
20+
noClasses = false
21+
tabWidth = 2
22+
# Uncomment if you want your chosen highlight style used for code blocks without a specified language
23+
# guessSyntax = "true"
24+
25+
## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday
26+
# [blackfriday]
27+
# plainIDAnchors = true
28+
# hrefTargetBlank = true
29+
# angledQuotes = false
30+
# latexDashes = true
31+
32+
# Highlighting config
33+
# pygmentsCodeFences = true
34+
# pygmentsUseClasses = false
35+
# # Use the new Chroma Go highlighter in Hugo.
36+
# pygmentsUseClassic = false
37+
# #pygmentsOptions = "linenos=table"
38+
# # See https://help.farbox.com/pygments.html
39+
# pygmentsStyle = "emacs"

‎config/_default/menus/menu.en.toml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Top-level navigation (horizontal)
2+
3+
[[main]]
4+
name = "About"
5+
weight = 100
6+
url = "#about"
7+
8+
[[main]]
9+
name = "Documentation"
10+
weight = 200
11+
url = "/docs"
12+
13+
[[main]]
14+
name = "Community"
15+
weight = 300
16+
url = "#community"
17+

‎config/_default/params.toml‎

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
# Everything below this are Site Params
2+
copyright = "The OpenReports Authors"
3+
4+
# sets the maximum number of lines per codeblock. The codeblock will however be scrollable and expandable.
5+
codeMaxLines = 0 # to enable function set >= 1
6+
7+
# disable showing line numbers by default. Switch to `true` if you'd rather have them on.
8+
showLineNumbers = false
9+
10+
# Menu title if your navbar has a versions selector to access old versions of your site.
11+
# This menu appears only if you have at least one [versions] set.
12+
# version_menu = "v1.0.0"
13+
14+
# Flag used in the "version-banner" partial to decide whether to display a
15+
# banner on every page indicating that this is an archived version of the docs.
16+
# Set this flag to "true" if you want to display the banner.
17+
archived_version = false
18+
19+
# The version number for the version of the docs represented in this doc set.
20+
# Used in the "version-banner" partial to display a version number for the
21+
# current doc set.
22+
#version = "v1.0.0"
23+
24+
# A link to latest version of the docs. Used in the "version-banner" partial to
25+
# point people to the main doc site.
26+
#url_latest_version = "https://openreports.io"
27+
28+
# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
29+
github_repo = "https://github.com/openreports/website"
30+
github_branch = "main"
31+
32+
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
33+
github_project_repo = "https://github.com/kyverno/kyverno"
34+
35+
# Specify a value here if your content directory is not in your repo's root directory
36+
# github_subdir = ""
37+
38+
# Google Custom Search Engine ID. Remove or comment out to disable search.
39+
# gcs_engine_id = "016003b0b44d00772"
40+
41+
# Enable Lunr.js offline search
42+
offlineSearch = true
43+
44+
# Enable syntax highlighting and copy buttons on code blocks with Prism
45+
prism_syntax_highlighting = false
46+
47+
time_format_blog = "Monday, January 02, 2006"
48+
time_format_default = "January 02, 2006 at 3:04 PM PST"
49+
50+
[mermaid]
51+
enable = true
52+
53+
[[policyFilters]]
54+
title = "Policy Type"
55+
filterID = "policytype"
56+
isFixed = true
57+
weight = 1
58+
59+
[[policyFilters]]
60+
title = "Policy Category"
61+
filterID = "category"
62+
weight = 2
63+
64+
[[policyFilters]]
65+
title = "Minimum Version" # title on the UI
66+
filterID = "version" # key you used inside index.json
67+
weight = 3
68+
69+
[[policyFilters]]
70+
title = "Subject" # title on the UI
71+
filterID = "subject" # key you used inside index.json
72+
weight = 4
73+
74+
# User interface configuration
75+
[ui]
76+
77+
# Enable to show the side bar menu in its compact state.
78+
sidebar_menu_compact = true
79+
80+
# Set to true to disable breadcrumb navigation.
81+
breadcrumb_disable = false
82+
83+
# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
84+
sidebar_search_disable = true
85+
86+
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top nav bar
87+
navbar_logo = false
88+
89+
# Set to true to disable the About link in the site footer
90+
footer_about_enable = true
91+
92+
# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
93+
# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
94+
# If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
95+
# add "hide_feedback: true" to the page's front matter.
96+
[ui.feedback]
97+
enable = true
98+
99+
# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
100+
yes = 'Glad to hear it! Please <a href="https://github.com/kyverno/website/issues/new/choose">tell us how we can improve</a>.'
101+
no = 'Sorry to hear that. Please <a href="https://github.com/kyverno/website/issues/new/choose">tell us how we can improve</a>.'
102+
103+
# Adds a reading time to the top of each doc.
104+
# If you want this feature, but occasionally need to remove the Reading time from a single page,
105+
# add "hide_readingtime: true" to the page's front matter
106+
[ui.readingtime]
107+
enable = false
108+
109+
[links]
110+
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
111+
112+
[[links.user]]
113+
name ="OpenReports GitHub repository"
114+
url = "https://github.com/openreports"
115+
icon = "fab fa-github"
116+
desc = "Kyverno GitHub"
117+
[[links.user]]
118+
name = "OpenReports channel on the CNCF slack workspace"
119+
url = "https://slack.cncf.io/#openreports"
120+
icon = "fab fa-slack"
121+
desc = "OpenReports channel on the CNCF slack workspace"
122+
123+
[pushAssets]
124+
css = [
125+
"callouts",
126+
"styles"
127+
]
128+
129+
js = [
130+
"script"
131+
]

0 commit comments

Comments
 (0)