Adds basic website (#289)

Signed-off-by: Adrian Cole <[email protected]>

.bingo/Variables.mk

@@ -35,6 +35,12 @@ $(GORELEASER): $(BINGO_DIR)/goreleaser.mod
 	@echo "(re)installing $(GOBIN)/goreleaser-v0.166.0"
 	@cd $(BINGO_DIR) && $(GO) build -mod=mod -modfile=goreleaser.mod -o=$(GOBIN)/goreleaser-v0.166.0 "github.com/goreleaser/goreleaser"
 
+HUGO := $(GOBIN)/hugo-v0.85.0
+$(HUGO): $(BINGO_DIR)/hugo.mod
+	@# Install binary/ries using Go 1.14+ build command. This is using bwplotka/bingo-controlled, separate go module with pinned dependencies.
+	@echo "(re)installing $(GOBIN)/hugo-v0.85.0"
+	@cd $(BINGO_DIR) && $(GO) build -mod=mod -modfile=hugo.mod -o=$(GOBIN)/hugo-v0.85.0 "github.com/gohugoio/hugo"
+
 LICENSER := $(GOBIN)/licenser-v0.6.0
 $(LICENSER): $(BINGO_DIR)/licenser.mod
 	@# Install binary/ries using Go 1.14+ build command. This is using bwplotka/bingo-controlled, separate go module with pinned dependencies.

.bingo/hugo.mod

@@ -0,0 +1,5 @@
+module _ // Auto generated by https://github.com/bwplotka/bingo. DO NOT EDIT
+
+go 1.16
+
+require github.com/gohugoio/hugo v0.80.0

.gitmodules

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

.licenserignore

@@ -17,3 +17,6 @@ last_known_envoy.txt
 testdata/
 site/*.json
 e2e/*.yaml
+
+netlify.toml
+site/

DEVELOPER.md

@@ -29,3 +29,10 @@ make coverage
 ### How to run end-to-end Tests
 
 See [test/e2e](e2e) for how to develop or run end-to-end tests
+
+### How to test the website
+
+Run below, then view with http://localhost:1313/
+```shell
+make site
+```

Makefile

@@ -32,6 +32,13 @@ bin $(BIN): $(GORELEASER)
 	@echo "--- bin ---"
 	@$(GORELEASER) build --snapshot --single-target --rm-dist
 
+##@ Test website
+.PHONY: site
+site: $(HUGO)
+	@echo "--- site ---"
+	@git submodule update
+	@cd site && $(HUGO) server -D
+
 ##@ Unit and End-to-End tests
 
 TEST_PACKAGES ?= $(shell go list ./... | grep -v -e github.com/tetratelabs/func-e/e2e -e github.com/tetratelabs/func-e/site)

README.md

@@ -15,7 +15,7 @@ $ curl -L https://func-e.io/install.sh | bash -s -- -b /usr/local/bin
 $ func-e run --config-yaml "admin: {address: {socket_address: {address: '127.0.0.1', port_value: 9901}}}"
 ```
 
-Run `func-e help` or have a look at the [Usage Docs](site/usage.md) for more information.
+Run `func-e help` or have a look at the [Usage Docs](USAGE.md) for more information.
 
 -----
 Envoy® is a registered trademark of The Linux Foundation in the United States and/or other countries

internal/cmd/usage_md_test.go

@@ -25,7 +25,7 @@ import (
 	"github.com/tetratelabs/func-e/internal/globals"
 )
 
-const siteMarkdownFile = "../../site/usage.md"
+const siteMarkdownFile = "../../USAGE.md"
 
 // TestUsageMarkdownMatchesCommands is in the "cmd" package because changes here will drift siteMarkdownFile.
 func TestUsageMarkdownMatchesCommands(t *testing.T) {

netlify.toml

@@ -0,0 +1,15 @@
+[build]
+  base = "site"
+  publish = "public"
+
+[build.environment]
+  HUGO_VERSION = "0.85.0"
+
+[context.production]
+  command = "hugo --gc --minify"
+
+[context.deploy-preview]
+  command = "hugo --gc --minify -b $DEPLOY_PRIME_URL"
+
+[context.branch-deploy]
+  command = "hugo --gc --minify -b $DEPLOY_PRIME_URL"

site/.gitignore

@@ -0,0 +1,2 @@
+resources/
+public/

site/README.md

@@ -1,8 +1,8 @@
-# Envoy site
+# func-e.io
 
-The following files are hosted on https://func-e.io, specifically via [Netlify redirects](https://github.com/tetratelabs/func-e.io/blob/master/site/static/_redirects):
+This directory holds the func-e site's source code. To visit the site click [here](https://func-e.io/)
 
-Latest master merge:
-* https://func-e.io/install.sh -> [./install.sh](install.sh)
-* https://www.func-e.io/usage/ -> [./usage.md](usage.md)
-  * this is verified by [usage_md_test.go](../internal/cmd/usage_md_test.go)
+The website is built using [Hugo](https://gohugo.io/), as static website generator, and [Syna](https://about.okkur.org/syna/) theme.
+
+## Deployment process
+This site deploys via Netlify on change to the `master` branch.

site/config.toml

@@ -0,0 +1,29 @@
+baseurl = "https://func-e.io/"
+languageCode = "en-us"
+defaultContentLanguage = "en"
+title = "func-e"
+theme = "syna"
+enableGitInfo = true
+disableKinds = ["RSS", "taxonomy", "taxonomyTerm"]
+ignorefiles = [ "content/dev/.*" ]
+
+[params]
+  name = "func-e"
+  title ="func-e (pronounced funky) makes running Envoy® easy"
+  description = "func-e allows you to quickly see available versions of Envoy and try them out"
+  author = "Tetrate"
+
+[[menu.main]]
+  url = "https://github.com/tetratelabs/func-e/blob/master/USAGE.md"
+  name = "Usage"
+  weight = 20
+
+[[menu.main]]
+  url = "https://github.com/tetratelabs/func-e/releases"
+  name = "Releases"
+  weight = 30
+
+[[menu.main]]
+  url = "https://github.com/tetratelabs/func-e"
+  name = "GitHub"
+  weight = 40

site/content/_global/copyright.md

@@ -0,0 +1,8 @@
++++
+fragment = "copyright"
+date = "2021-07-06"
+weight = 1250
+background = "dark"
+
+copyright = "2021 © Tetrate.io. Envoy® is a registered trademark of The Linux Foundation in the United States and/or other countries." 
++++

site/content/_global/index.md

@@ -0,0 +1,3 @@
++++
+headless = true
++++

site/content/_global/nav.md

@@ -0,0 +1,13 @@
++++
+fragment = "nav"
+date = "2021-07-06"
+weight = 0
+sticky = true
+background = "dark"
+
+# Branding options
+[asset]
+  image = "branding_logo.svg"
+  text = "func-e"
+
++++

site/content/_index.md

@@ -0,0 +1,7 @@
++++
+title = "func-e"
+date = "2021-07-06"
+subtitle = "func-e (pronounced funky) makes running Envoy® easy"
+description = "func-e allows you to quickly see available versions of Envoy and try them out"
++++
+

site/content/_index/features/consistent.md

@@ -0,0 +1,10 @@
++++
+title = "Consistent"
+date = "2021-07-06"
+weight = 20
+
+[asset]
+ icon = "fas fa-copy"
++++
+
+`func-e use` pins the version when you need to

site/content/_index/features/easy.md

@@ -0,0 +1,10 @@
++++
+title = "Easy"
+date = "2021-07-06"
+weight = 10
+
+[asset]
+ icon = "fas fa-box-open"
++++
+
+One command to get started: `func-e run`

site/content/_index/features/index.md

@@ -0,0 +1,8 @@
++++
+fragment = "items"
+date = "2021-07-06"
+weight = 150
+
+title = "Features"
+subtitle= ""
++++

site/content/_index/hero.md

@@ -0,0 +1,10 @@
++++
+fragment = "hero"
+date = "2021-07-06"
+weight = 110
+background = "light"
+particles = true
+
+title = "func-e makes running Envoy® easy"
+
++++

site/content/_index/index.md

@@ -0,0 +1,4 @@
++++
+headless = true
++++
+

site/content/_index/installation/index.md

@@ -0,0 +1,16 @@
++++
+fragment = "content"
+date = "2021-07-06"
+weight = 150
++++
+
+func-e (pronounced funky) allows you to quickly see available versions of Envoy and try them out. This makes it easy to validate
+configuration you would use in production. Each time you end a run, a snapshot of runtime state is taken on
+your behalf. This makes knowledge sharing and troubleshooting easier, especially when upgrading. Try it out!
+
+```sh
+$ curl -L https://func-e.io/install.sh | bash -s -- -b /usr/local/bin
+$ func-e run -c /path/to/envoy.yaml
+# If you don't have a configuration file, you can start the admin port like this
+$ func-e run --config-yaml "admin: {address: {socket_address: {address: '127.0.0.1', port_value: 9901}}}"
+```