{{ site.footer.title }}
-{{ site.footer.content }}
-{{ site.footer.cta_title }}
- {{ site.footer.cta_text }} -diff --git a/site/Gemfile b/site/Gemfile deleted file mode 100644 index a07a4ff7ec2..00000000000 --- a/site/Gemfile +++ /dev/null @@ -1,16 +0,0 @@ -source 'https://rubygems.org' - -group :jekyll_plugins do - gem 'jekyll', '~> 4' - gem 'jekyll-seo-tag', '~> 2.6', '>= 2.6.1' # Automatically create SEO tags - gem 'jekyll-sitemap', '~> 1.3', '>= 1.3.1' # Create a sitemap using the official Jekyll sitemap gem - gem 'jekyll-feed', '~> 0.12.1' # Create an Atom feed using the official Jekyll feed gem - gem 'jekyll-relative-links', '~> 0.6.1' # Used to auto generate md links to html links - gem 'jekyll-paginate', '~> 1.1' # pagination object for collections (e.g. posts) - gem 'html-proofer', '~> 3.16' # Link validation - gem "jekyll-github-metadata", github: "jekyll/github-metadata" # TODO fork repo and update github link reference - gem 'jekyll-optional-front-matter', '~> 0.3.2' # Parse Markdown files that do not have front-matter callouts - gem 'jekyll-titles-from-headings', '~> 0.5.3' # pull the page title from the first Markdown heading when none is specified.) - gem 'jekyll-readme-index', '~> 0.3.0' - gem 'jekyll-redirect-from', '~> 0.15.0' -end diff --git a/site/Gemfile.lock b/site/Gemfile.lock deleted file mode 100644 index a55f1ab63ba..00000000000 --- a/site/Gemfile.lock +++ /dev/null @@ -1,132 +0,0 @@ -GIT - remote: https://github.com/jekyll/github-metadata.git - revision: c0d0fa8057c02bb5de23af90b4b8c27e529350d7 - specs: - jekyll-github-metadata (2.13.0) - jekyll (>= 3.4, < 5.0) - octokit (~> 4.0, != 4.4.0) - -GEM - remote: https://rubygems.org/ - specs: - addressable (2.7.0) - public_suffix (>= 2.0.2, < 5.0) - colorator (1.1.0) - concurrent-ruby (1.1.5) - em-websocket (0.5.1) - eventmachine (>= 0.12.9) - http_parser.rb (~> 0.6.0) - ethon (0.12.0) - ffi (>= 1.3.0) - eventmachine (1.2.7) - faraday (1.0.1) - multipart-post (>= 1.2, < 3) - ffi (1.11.1) - forwardable-extended (2.6.0) - html-proofer (3.16.0) - addressable (~> 2.3) - mercenary (~> 0.3) - nokogumbo (~> 2.0) - parallel (~> 1.3) - rainbow (~> 3.0) - typhoeus (~> 1.3) - yell (~> 2.0) - http_parser.rb (0.6.0) - i18n (1.7.0) - concurrent-ruby (~> 1.0) - jekyll (4.0.0) - addressable (~> 2.4) - colorator (~> 1.0) - em-websocket (~> 0.5) - i18n (>= 0.9.5, < 2) - jekyll-sass-converter (~> 2.0) - jekyll-watch (~> 2.0) - kramdown (~> 2.1) - kramdown-parser-gfm (~> 1.0) - liquid (~> 4.0) - mercenary (~> 0.3.3) - pathutil (~> 0.9) - rouge (~> 3.0) - safe_yaml (~> 1.0) - terminal-table (~> 1.8) - jekyll-feed (0.12.1) - jekyll (>= 3.7, < 5.0) - jekyll-optional-front-matter (0.3.2) - jekyll (>= 3.0, < 5.0) - jekyll-paginate (1.1.0) - jekyll-readme-index (0.3.0) - jekyll (>= 3.0, < 5.0) - jekyll-redirect-from (0.15.0) - jekyll (>= 3.3, < 5.0) - jekyll-relative-links (0.6.1) - jekyll (>= 3.3, < 5.0) - jekyll-sass-converter (2.0.1) - sassc (> 2.0.1, < 3.0) - jekyll-seo-tag (2.6.1) - jekyll (>= 3.3, < 5.0) - jekyll-sitemap (1.3.1) - jekyll (>= 3.7, < 5.0) - jekyll-titles-from-headings (0.5.3) - jekyll (>= 3.3, < 5.0) - jekyll-watch (2.2.1) - listen (~> 3.0) - kramdown (2.3.0) - rexml - kramdown-parser-gfm (1.1.0) - kramdown (~> 2.0) - liquid (4.0.3) - listen (3.2.0) - rb-fsevent (~> 0.10, >= 0.10.3) - rb-inotify (~> 0.9, >= 0.9.10) - mercenary (0.3.6) - mini_portile2 (2.4.0) - multipart-post (2.1.1) - nokogiri (1.10.10) - mini_portile2 (~> 2.4.0) - nokogumbo (2.0.2) - nokogiri (~> 1.8, >= 1.8.4) - octokit (4.18.0) - faraday (>= 0.9) - sawyer (~> 0.8.0, >= 0.5.3) - parallel (1.19.2) - pathutil (0.16.2) - forwardable-extended (~> 2.6) - public_suffix (4.0.1) - rainbow (3.0.0) - rb-fsevent (0.10.3) - rb-inotify (0.10.0) - ffi (~> 1.0) - rexml (3.2.4) - rouge (3.12.0) - safe_yaml (1.0.5) - sassc (2.2.1) - ffi (~> 1.9) - sawyer (0.8.2) - addressable (>= 2.3.5) - faraday (> 0.8, < 2.0) - terminal-table (1.8.0) - unicode-display_width (~> 1.1, >= 1.1.1) - typhoeus (1.4.0) - ethon (>= 0.9.0) - unicode-display_width (1.6.0) - yell (2.2.2) - -PLATFORMS - ruby - -DEPENDENCIES - html-proofer (~> 3.16) - jekyll (~> 4) - jekyll-feed (~> 0.12.1) - jekyll-github-metadata! - jekyll-optional-front-matter (~> 0.3.2) - jekyll-paginate (~> 1.1) - jekyll-readme-index (~> 0.3.0) - jekyll-redirect-from (~> 0.15.0) - jekyll-relative-links (~> 0.6.1) - jekyll-seo-tag (~> 2.6, >= 2.6.1) - jekyll-sitemap (~> 1.3, >= 1.3.1) - jekyll-titles-from-headings (~> 0.5.3) - -BUNDLED WITH - 2.1.4 diff --git a/site/README.md b/site/README.md index af032ccfec4..337d613471c 100644 --- a/site/README.md +++ b/site/README.md @@ -1,11 +1,17 @@ -# site +# Website for Contour -This directory contains the Jekyll source for [projectcontour.io][0]. +##### Prerequisites -The site is deployed directly from the [`main`][1] branch, copies of the site's source in older tags and branches are non-canonical. +* [Hugo](https://github.com/gohugoio/hugo) + * macOS: `brew install hugo` + * Windows: `choco install hugo-extended -confirm` -Site specific contribution information can be found at [SITE_CONTRIBUTION.md][2]. +#### Build -[0]: https://projectcontour.io/ -[1]: https://github.com/projectcontour/contour/ -[2]: https://github.com/projectcontour/contour/blob/main/SITE_CONTRIBUTION.md +```bash +hugo server --disableFastRender +``` + +#### Serve + +Serve site at http://localhost:1313 diff --git a/site/_config.yml b/site/_config.yml deleted file mode 100644 index a11e4485d43..00000000000 --- a/site/_config.yml +++ /dev/null @@ -1,233 +0,0 @@ -# Site settings -title: Contour -email: -author: Contour Authors -description: High performance ingress controller for Kubernetes -url: https://projectcontour.io -logo: Contour.svg -twitter: - username: projectcontour - card: summary -vm_logo: vm-logo.png -cncf_logo: cncf-color.png -gh_repo: https://github.com/projectcontour/contour -highlighter: rouge -markdown: kramdown -kramdown: - syntax_highlighter: rouge -hero: - background-color: dark-blue -footer: - title: Ready to try Contour? - content: Read our getting started documentation. - cta_url: /getting-started/ - cta_text: Getting Started -footer_social_links: - Twitter: - fa_icon: fab fa-twitter - url: https://twitter.com/projectcontour - Slack: - fa_icon: fab fa-slack - url: https://kubernetes.slack.com/messages/contour - RSS: - fa_icon: fa fa-rss - url: /feed.xml - GitHub: - fa_icon: fab fa-github - url: https://github.com/projectcontour/contour -defaults: -- scope: - path: "" # an empty string here means all files in the project - type: "posts" - values: - layout: "posts" -- scope: - path: "" - values: - layout: "default" - toc: "h2, h3" # Default TOC levels, see _includes/footer.html. -- scope: - path: docs/main - values: - version: main - layout: "docs" -- scope: - path: docs/v1.2.1 - values: - version: v1.2.1 - layout: "docs" -- scope: - path: docs/v1.2.0 - values: - version: v1.2.0 - layout: "docs" -- scope: - path: docs/v1.1.0 - values: - version: v1.1.0 - layout: "docs" -- scope: - path: docs/v1.0.0 - values: - version: v1.0.0 - layout: "docs" -- scope: - path: docs/v1.0.1 - values: - version: v1.0.1 - layout: "docs" -- scope: - path: docs/v1.3.0 - values: - version: v1.3.0 - layout: "docs" -- scope: - path: docs/v1.4.0 - values: - version: v1.4.0 - layout: "docs" -- scope: - path: docs/v1.5.0 - values: - version: v1.5.0 - layout: "docs" -- scope: - path: docs/v1.5.1 - values: - version: v1.5.1 - layout: "docs" -- scope: - path: docs/v1.6.0 - values: - version: v1.6.0 - layout: "docs" -- scope: - path: docs/v1.6.1 - values: - version: v1.6.1 - layout: "docs" -- scope: - path: docs/v1.7.0 - values: - version: v1.7.0 - layout: "docs" -- scope: - path: docs/v1.8.0 - values: - version: v1.8.0 - layout: "docs" -- scope: - path: docs/v1.8.1 - values: - version: v1.8.1 - layout: "docs" -- scope: - path: docs/v1.8.2 - values: - version: v1.8.2 - layout: "docs" -- scope: - path: docs/v1.9.0 - values: - version: v1.9.0 - layout: "docs" -- scope: - path: docs/v1.10.0 - values: - version: v1.10.0 - layout: "docs" -- scope: - path: docs/v1.10.1 - values: - version: v1.10.1 - layout: "docs" -- scope: - path: docs/v1.11.0 - values: - version: v1.11.0 - layout: "docs" -repository: projectcontour/contour -collections: - guides: - output: true - resources: - output: true - docs_1_0: - output: true - permalink: /docs/1.0/:name - contributors: - output: false - features: - output: false - metrics: - output: false -versioning: true -latest: v1.11.0 -versions: -- main -- v1.11.0 -- v1.10.1 -- v1.10.0 -- v1.9.0 -- v1.8.2 -- v1.8.1 -- v1.8.0 -- v1.7.0 -- v1.6.1 -- v1.6.0 -- v1.5.1 -- v1.5.0 -- v1.4.0 -- v1.3.0 -- v1.2.1 -- v1.2.0 -- v1.1.0 -- v1.0.1 -- v1.0.0 -# Build settings -permalink: :title/ -sass: - sass_dir: css - style: :compressed -page_gen: -- data: shortlinks - template: redirect - name: key - dir: docs -# Use the following plug-ins -plugins: -- jekyll-sitemap # Create a sitemap using the official Jekyll sitemap gem -- jekyll-feed # Create an Atom feed using the official Jekyll feed gem -- jekyll-relative-links # Used to auto generate md links to html links -- jekyll-optional-front-matter # Parse Markdown files that do not have front-matter callouts -- jekyll-readme-index # use README.md as index.html -- jekyll-titles-from-headings # pull the page title from the first Markdown heading when none is specified. -- jekyll-paginate # pagination object for collections (e.g. posts) -- jekyll-github-metadata -- jekyll-redirect-from -- jekyll-seo-tag -# Include these subdirectories -include: -- CONTRIBUTING.md -- README.md -- _redirects -- examples -- examples/proxydemo -# Exclude these files from your production _site -exclude: -- Gemfile -- Gemfile.lock -- README-JEKYLL.md -- LICENSE -- CNAME -- Runbook.docx -- '*.sh' -- vendor -- bundler/bundle/ -- bundler/cache/ -- bundler/gems/ -- bundler/ruby/ -- node_modules -# Fail build on errors -liquid: - error_mode: strict diff --git a/site/_contributors/01-nick-young.md b/site/_contributors/01-nick-young.md deleted file mode 100644 index 68250229609..00000000000 --- a/site/_contributors/01-nick-young.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -first_name: Nick -last_name: Young -image: /img/contributors/nick-young.png -github_handle: youngnick ---- -Tech Lead / Maintainer diff --git a/site/_contributors/02-james-peach.md b/site/_contributors/02-james-peach.md deleted file mode 100644 index 2c9c98c6927..00000000000 --- a/site/_contributors/02-james-peach.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -first_name: James -last_name: Peach -image: /img/contributors/jpeach.png -github_handle: jpeach ---- -Maintainer diff --git a/site/_contributors/02-steve-kriss.md b/site/_contributors/02-steve-kriss.md deleted file mode 100644 index e1ac66ca312..00000000000 --- a/site/_contributors/02-steve-kriss.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -first_name: Steve -last_name: Kriss -image: /img/contributors/steve-kriss.png -github_handle: skriss ---- -Maintainer diff --git a/site/_contributors/02-steve-sloka.md b/site/_contributors/02-steve-sloka.md deleted file mode 100644 index 072e414788e..00000000000 --- a/site/_contributors/02-steve-sloka.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -first_name: Steve -last_name: Sloka -image: /img/contributors/steve-sloka.png -github_handle: stevesloka ---- -Maintainer diff --git a/site/_contributors/03-tong-liu.md b/site/_contributors/03-tong-liu.md deleted file mode 100644 index a76b41c1721..00000000000 --- a/site/_contributors/03-tong-liu.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -first_name: Tong -last_name: Liu -image: /img/contributors/tong-liu.png -github_handle: tong101 ---- -Engineering Manager diff --git a/site/_contributors/04-alex-xu.md b/site/_contributors/04-alex-xu.md deleted file mode 100644 index 498f096f4bf..00000000000 --- a/site/_contributors/04-alex-xu.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -first_name: Alex -last_name: Xu -image: /img/contributors/alex-xu.png -github_handle: xaleeks ---- -Product Manager diff --git a/site/_data/refdocs/config.json b/site/_data/refdocs/config.json deleted file mode 100644 index dcd5eb9de93..00000000000 --- a/site/_data/refdocs/config.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "hideMemberFields": [ - "TypeMeta" - ], - "hideTypePatterns": [ - "ParseError$", - "List$" - ], - "externalPackages": [ - { - "typeMatchPrefix": "^k8s\\.io/apimachinery/pkg/apis/meta/v1\\.Duration$", - "docsURLTemplate": "https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration" - }, - { - "typeMatchPrefix": "^k8s\\.io/(api|apimachinery/pkg/apis)/", - "docsURLTemplate": "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#{{lower .TypeIdentifier}}-{{arrIndex .PackageSegments -1}}-{{arrIndex .PackageSegments -2}}" - }, - { - "typeMatchPrefix": "^github\\.com/knative/pkg/apis/duck/", - "docsURLTemplate": "https://godoc.org/github.com/knative/pkg/apis/duck/{{arrIndex .PackageSegments -1}}#{{.TypeIdentifier}}" - } - ], - "typeDisplayNamePrefixOverrides": { - "k8s.io/api/": "Kubernetes ", - "k8s.io/apimachinery/pkg/apis/": "Kubernetes " - }, - "markdownDisabled": false -} diff --git a/site/_data/refdocs/members.tpl b/site/_data/refdocs/members.tpl deleted file mode 100644 index b66843e50b2..00000000000 --- a/site/_data/refdocs/members.tpl +++ /dev/null @@ -1,49 +0,0 @@ -{{ define "members" }} - -{{ range .Members }} -{{ if not (hiddenMember .)}} -
{{ fieldName . }}
-
- (Members of {{ fieldName . }} are embedded into this type.)
-
metadata field.
- {{ end }}
-
- {{ if or (eq (fieldName .) "spec") }}
- Packages:
-- {{ safe (renderComments .) }} -
- {{ end }} - {{ end }} - - Resource Types: -
- Generated with gen-crd-api-reference-docs.
-
{{.Underlying}} alias){{ end -}}
-- (Appears on: - {{- $prev := "" -}} - {{- range . -}} - {{- if $prev -}}, {{ end -}} - {{ $prev = . }} - {{ typeDisplayName . }} - {{- end -}} - ) -
-{{ end }} - - -- {{ safe (renderComments .CommentLines) }} -
- -{{ if .Members }} -| Field | -Description | -
|---|---|
- apiVersion
- - string |
-
-
- {{apiGroup .}}
-
- |
-
- kind
- - string - |
- {{.Name.Name}} |
-
{{ site.title }} is released as open source software and provides community support through our GitHub project page. - If you encounter an issue or have a question, feel free to reach out on the GitHub issues page for {{ site.title }}.
- -The Contour project team welcomes contributions from the community, please see our contributing documentation.
-{{ feature.content | markdownify }}
- {% for link in feature.links %} - {{ link[0] }} - {% endfor %} -{{ feature.content | markdownify }}
- {% for link in feature.links %} - {{ link[0] }} - {% endfor %} -{{ site.footer.content }}
-{{ site.footer.cta_title }}
- {{ site.footer.cta_text }} -