Skip to content

Commit

Permalink
Merge pull request #1 from ppeble/hugo-setup
Browse files Browse the repository at this point in the history
Initial hugo setup
  • Loading branch information
ppeble authored Apr 23, 2024
2 parents 69f1cc4 + a1f0ccf commit 74f0a61
Show file tree
Hide file tree
Showing 4,884 changed files with 348 additions and 18 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
11 changes: 11 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# npm assets
node_modules/
package-lock.json

# Hugo-generated assets
.hugo_build.lock
/public
resources/

# Local Netlify folder
.netlify
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "themes/docsy"]
path = themes/docsy
url = https://github.com/google/docsy.git
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
lts/*
File renamed without changes.
15 changes: 3 additions & 12 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,6 @@
#
# SPDX-License-Identifier: Apache-2.0

generate/files = LICENSE.txt

generate: generate-clean
$(MAKE) $(generate/files)
.PHONY: generate

generate-clean:
rm -f $(generate/files)
.PHONY: generate-clean

LICENSE.txt:
curl https://apache.org/licenses/LICENSE-2.0.txt > $@
.PHONY: run
run:
npm run serve
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# emissary-ingress.dev

The [emissary-ingress.dev][] website, built using [Hugo][] and hosted on [Netlify][].

## Local build

To build and serve the site, you'll need the latest [LTS release][] of **Node**.
Like Netlify, we use **[nvm][]**, the Node Version Manager, to install and
manage Node versions:

```console
$ nvm install --lts
```

You must also install [hugo](https://gohugo.io/getting-started/installing/) to build the site.

### Setup

1. Clone this repo.
2. From a terminal window, change to the cloned repo directory.
3. Get NPM packages and git submodules, including the the [Docsy][] theme:
```console
$ npm install
```

### Build or serve the site

To locally serve the site at [localhost:1313][], run the following command:

```console
$ make run
```

[Docsy]: https://www.docsy.dev
[Hugo]: https://gohugo.io
[localhost:1313]: http://localhost:1313
[LTS release]: https://nodejs.org/en/download/
[Netlify]: https://netlify.com
[nvm]: https://github.com/nvm-sh/nvm/blob/master/README.md#installing-and-updating
229 changes: 229 additions & 0 deletions config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,229 @@
---
baseURL: https://emmisary-ingress.dev
enableRobotsTxt: true

module:
replacements: 'github.com/FortAwesome/Font-Awesome -> ., github.com/twbs/bootstrap -> .'
imports:
- path: docsy

themesDir: "node_modules" # docsy is installed via npm

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

# Language settings
contentDir: content/en
defaultContentLanguage: en
defaultContentLanguageInSubdir: false
languageCode: en-us
googleAnalytics: G-VF9H3EHMDK

# Useful when translating.
enableMissingTranslationPlaceholders: true

disableKinds: [taxonomy, term]

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

# Image processing configuration.
imaging:
resampleFilter: CatmullRom
quality: 75
anchor: smart

languages:
en:
params:
title: Emissary Ingress
description: >-
An open source Kubernetes-native API gateway for microservices built on the Envoy Proxy
languageName: English
contentDir: content/en
weight: 1

markup:
goldmark:
renderer:
unsafe: true
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

params:
copyright:
from_year: 2018
authors: |
emissary Authors
<div class="row text-center text-white small">
<div class="col-12 text-center py-2 order-sm-2">
<a href="https://www.linuxfoundation.org/terms" target="_blank" rel="noopener">Terms</a> |
<a href="https://www.linuxfoundation.org/privacy" target="_blank" rel="noopener">Privacy</a> |
<a href="https://www.linuxfoundation.org/trademark-usage" target="_blank" rel="noopener">Trademarks</a> |
<a href="https://github.com/emissary-ingress/emissary-ingress.dev/blob/main/LICENSE" target="_blank" rel="noopener">License</a>
</div>
</div>
description: >-
An open source Kubernetes-native API gateway for microservices built on the Envoy Proxy
# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
github_repo: https://github.com/emissary-ingress/emissary-ingress.dev
github_branch: main

# An optional link to a related project repo. For example, the sibling repository where your product code lives.
github_project_repo: https://github.com/emissary-ingress/emissary

# Enable Lunr.js offline search
offlineSearch: true

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

# Versions

# 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: Versions
latest_stable_version: 3.8
versions:
- version: v3.8
url: /docs/3.8/

- version: v3.7
url: /docs/3.7/

- version: v3.6
url: /docs/3.6/

- version: v3.5
url: /docs/3.5/

- version: v3.4
url: /docs/3.4/

- version: v3.3
url: /docs/3.3/

- version: v3.2
url: /docs/3.2/

- version: v3.1
url: /docs/3.1/

- version: v3.0
url: /docs/3.0/

- version: v2.5
url: /docs/2.5/

- version: v2.4
url: /docs/2.4/

- version: v2.3
url: /docs/2.3/

- version: v2.2
url: /docs/2.2/

- version: v2.1
url: /docs/2.1/

- version: v2.0
url: /docs/2.0/

- version: v1.14
url: /docs/1.14/

- version: v1.13
url: /docs/1.13/

# User interface configuration
ui:
sidebar_menu_compact: true
sidebar_search_disable: true
navbar_logo: true
footer_about_enable: false
navbar_translucent_over_cover_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.
feedback:
enable: true
# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
'yes': >-
Glad to hear it! Please <a
href="https://github.com/emissary-ingress/emissary-ingress.dev/issues/new">tell us how we
can improve</a>.
'no': >-
Sorry to hear that. Please <a
href="https://github.com/emissary-ingress/emissary-ingress.dev/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
readingtime:
enable: false

# Footer Links
links:
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
user:
- name: Google Group
url: https://groups.google.com/g/etcd-dev
icon: fab fa-google
- name: Twitter
url: https://twitter.com/etcdio
icon: fab fa-twitter
- name: Github Discussions
url: https://github.com/etcd-io/etcd/discussions
icon: fab fa-github
# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
developer:
- name: Etcd on GitHub
url: https://github.com/etcd-io/etcd
icon: fab fa-github-square
- name: Etcd.io on GitHub
url: https://github.com/etcd-io/website
icon: fab fa-github
# [params.logos]
hero: >-
https://raw.githubusercontent.com/cncf/artwork/master/projects/etcd/horizontal/white/etcd-horizontal-white.png
mediaTypes:
text/netlify: {}

outputFormats:
REDIRECTS:
mediaType: text/netlify
baseName: _redirects
notAlternative: true

outputs:
home: [HTML, REDIRECTS, RSS]

# Site menu (partial -- also see pages with 'menu' in front matter)
menu:
main:
- name: Docs
url: /docs/latest/
weight: -10
- name: Blog
pageref: /blog/
- name: Install
url: /docs/latest/install/
- name: Play
url: http://play.etcd.io/play
40 changes: 40 additions & 0 deletions content/en/_index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: emissary ingress
features:
- title: Simple interface
description: Read and write values using standard HTTP tools, such as curl
icon: interface.svg
- title: Key-value storage
description: Store data in hierarchically organized directories, as in a standard filesystem
icon: kv.svg
- title: Watch for changes
description: Watch specific keys or directories for changes and react to changes in values
icon: watch.svg
---

{{< blocks/cover image_anchor="top" height="min" color="primary" >}}
<img src="etcd-horizontal-white.png" class="site-logo" />
<h2 class="mt-4">
A Kubernetes-native API gateway for microservices built on the Envoy Proxy
</h2>
<div class="mt-5 mx-auto">
<a class="btn btn-lg btn-secondary mr-3 mb-4" href="/docs/{{< param latest_stable_version >}}/">
Learn more
</a>
<a class="btn btn-lg btn-primary mr-3 mb-4" href="/docs/{{< param latest_stable_version >}}/quickstart">
Quickstart<i class="fas fa-arrow-alt-circle-right ml-2"></i>
</a>
</div>
{{< /blocks/cover >}}

{{% blocks/lead color="white" %}}
<h1>What is etcd?</h1>
<p>
<b>etcd</b> is a strongly consistent, distributed key-value store that
provides a reliable way to store data that needs to be accessed by a
distributed system or cluster of machines. It gracefully handles leader
elections during network partitions and can tolerate machine failure, even
in the leader node.
<a href="/docs/{{< param latest_stable_version >}}/">Learn more<i class="fas fa-arrow-alt-circle-right ml-2"></i></a>
</p>
{{% /blocks/lead %}}
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Loading

0 comments on commit 74f0a61

Please sign in to comment.