chore: hugo initialization

Author: JTorreG

docs/developer/branching-and-workflow.md renamed to docs-developer/branching-and-workflow.md

@@ -0,0 +1,3 @@
+public
+.hugo_build.lock
+resources

docs/developer/design-principles.md renamed to docs-developer/design-principles.md

@@ -0,0 +1,68 @@
+title = "NGINX Gateway Fabric"
+enableGitInfo = false
+baseURL = "/"
+publishDir = "public/nginx-gateway-fabric"
+staticDir = ["static"]
+languageCode = "en-us"
+description = "NGINX Gateway Fabric."
+refLinksErrorLevel = "ERROR"
+enableRobotsTXT = "true"
+#canonifyURLs = true
+pluralizeListTitles = false
+pygmentsCodeFences = true
+pygmentsUseClasses = true
+
+[caches]
+  [caches.modules]
+    maxAge = -1
+
+[module]
+[[module.imports]]
+  path="github.com/nginxinc/nginx-hugo-theme"
+
+[markup]
+  [markup.highlight]
+    codeFences = true
+    guessSyntax = true
+    hl_Lines = ""
+    lineNoStart = 1
+    lineNos = false
+    lineNumbersInTable = true
+    noClasses = true
+    style = "monokai"
+    tabWidth = 4
+  [markup.goldmark]
+    [markup.goldmark.extensions]
+      definitionList = true
+      footnote = true
+      linkify = true
+      strikethrough = true
+      table = true
+      taskList = true
+      typographer = true
+    [markup.goldmark.parser]
+      attribute = true
+      autoHeadingID = true
+      autoHeadingIDType = "gitlab"
+    [markup.goldmark.renderer]
+      hardWraps = false
+      unsafe = true
+      xhtml = false
+
+[params]
+  useSectionPageLists = "false"
+  buildtype = "webdocs"
+  RSSLink = "/index.xml"
+  author = "NGINX Inc." # add your company name
+  github = "nginxinc" # add your github profile name
+  twitter = "@nginx" # add your twitter profile
+  #email = ""
+  noindex_kinds = [
+    "taxonomy",
+    "taxonomyTerm"
+  ]
+  logo = "NGINX-product-icon.svg"
+
+sectionPagesMenu = "docs"
+
+ignoreFiles = [ "\\.sh$", "\\.DS_Store$", "\\.git.*$", "\\.txt$", "\\/config\\/.*", "README\\.*"]

docs/developer/go-style-guide.md renamed to docs-developer/go-style-guide.md

@@ -0,0 +1,4 @@
+baseURL = "https://docs-dev.nginx.com/nginx-gateway-fabric"
+title = "DEV -- NGINX Gateway Fabric"
+publishDir = "public/nginx-gateway-fabric"
+canonifyURLs = false

docs/developer/implementing-a-feature.md renamed to docs-developer/implementing-a-feature.md

@@ -0,0 +1,4 @@
+baseURL = "https://docs.nginx.com/nginx-gateway-fabric"
+title = "NGINX Gateway Fabric"
+publishDir = "public/nginx-gateway-fabric"
+canonifyURLs = false

docs/developer/logging-guidelines.md renamed to docs-developer/logging-guidelines.md

@@ -0,0 +1,4 @@
+baseURL = "https://docs-staging.nginx.com/nginx-gateway-fabric"
+title = "STAGING -- NGINX Gateway Fabric"
+publishDir = "public/nginx-gateway-fabric"
+canonifyURLs = false

docs/developer/pull-request.md renamed to docs-developer/pull-request.md

@@ -0,0 +1,5 @@
+module github.com/nginxinc/nalb-shared/docs
+
+go 1.18
+
+require github.com/nginxinc/nginx-hugo-theme v0.39.0 // indirect

docs/developer/quickstart.md renamed to docs-developer/quickstart.md

@@ -0,0 +1,4 @@
+github.com/nginxinc/nginx-hugo-theme v0.35.0 h1:7XB2GMy6qeJgKEJy9wOS3SYKYpfvLW3/H+UHRPLM4FU=
+github.com/nginxinc/nginx-hugo-theme v0.35.0/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M=
+github.com/nginxinc/nginx-hugo-theme v0.39.0 h1:P1hOPpityVUOM5OyIpQZa1UJyuUunGSmz0oZh/GYSJM=
+github.com/nginxinc/nginx-hugo-theme v0.39.0/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M=

docs/developer/release-process.md renamed to docs-developer/release-process.md

@@ -0,0 +1,92 @@
+HUGO?=hugo
+# the officially recommended unofficial docker image
+HUGO_IMG?=klakegg/hugo:0.115.3
+# NGINX Hugo theme module location
+THEME_MODULE=github.com/nginxinc/nginx-hugo-theme
+## Pulls the current theme version from the Netlify settings
+THEME_VERSION=$(NGINX_THEME_VERSION)
+
+
+# if there's no local hugo, fallback to docker
+ifeq (, $(shell ${HUGO} version 2> /dev/null))
+ifeq (, $(shell docker version 2> /dev/null))
+    $(error Docker and Hugo are not installed. Hugo (<0.91) or Docker are required to build the local preview.)
+else
+    HUGO=docker run --rm -it -v ${CURDIR}:/src -p 1313:1313 ${HUGO_IMG}
+endif
+endif
+
+MARKDOWNLINT?=markdownlint
+MARKDOWNLINT_IMG?=ghcr.io/igorshubovych/markdownlint-cli:latest
+
+# if there's no local markdownlint, fallback to docker
+ifeq (, $(shell ${MARKDOWNLINT} version 2> /dev/null))
+ifeq (, $(shell docker version 2> /dev/null))
+ifneq (, $(shell $(NETLIFY) "true"))
+    $(error Docker and markdownlint are not installed. markdownlint or Docker are required to lint.)
+else
+    MARKDOWNLINT=docker run --rm -i -v ${CURDIR}:/src --workdir /src ${MARKDOWNLINT_IMG}
+endif
+endif
+endif
+
+MARKDOWNLINKCHECK?=markdown-link-check
+MARKDOWNLINKCHECK_IMG?=ghcr.io/tcort/markdown-link-check:stable
+# if there's no local markdown-link-check, fallback to docker
+ifeq (, $(shell ${MARKDOWNLINKCHECK} --version 2> /dev/null))
+ifeq (, $(shell docker version 2> /dev/null))
+ifneq (, $(shell $(NETLIFY) "true"))
+    $(error Docker and markdown-link-check are not installed. markdown-link-check or Docker are required to check links.)
+else
+    MARKDOWNLINKCHECK=docker run --rm -it -v ${CURDIR}:/docs --workdir /docs ${MARKDOWNLINKCHECK_IMG}
+endif
+endif
+endif
+
+
+.PHONY: docs clean hugo-mod docs-local docs-drafts netlify lint-grammar lint-markdown link-check all all-staging all-dev
+
+## For use in Netlify CI only
+all: hugo-mod build-production
+
+all-staging: hugo-mod build-staging
+
+all-dev: hugo-mod build-dev
+## end for use in Netlify CI
+
+docs: 
+	${HUGO} server --disableFastRender
+
+clean:
+	rm -rf ./public
+
+docs-local: clean 
+	${HUGO}
+
+docs-drafts:
+	${HUGO} server -D --disableFastRender
+
+lint-grammar:
+	docker run --rm -it -v ${CURDIR}/content:/root/content --entrypoint "vale" --workdir /root/content artifactory.f5net.com/cylon-indigo-docker-dev/indigo/tools/docs/vale-lint:0.7.0 ./
+
+lint-markdown:
+	${MARKDOWNLINT} -c mdlint_conf.json  -- content
+
+link-check:
+	${MARKDOWNLINKCHECK} $(shell find content -name '*.md')
+
+## commands for use in Netlify CI
+hugo-mod:
+	hugo mod get $(THEME_MODULE)@v$(THEME_VERSION)
+
+build-production: hugo-mod
+	hugo --gc -e production
+
+build-staging: hugo-mod
+	hugo --gc -e staging
+
+build-dev: hugo-mod
+	hugo --gc -e development
+
+deploy-preview: hugo-mod
+	hugo --gc -d public/nginx-gateway-fabric/ -b ${NETLIFY_DEPLOY_URL}/nginx-gateway-fabric/

docs/developer/testing.md renamed to docs-developer/testing.md

@@ -0,0 +1,14 @@
+{
+    "replacementPatterns": [
+      {
+          "pattern": "^\/",
+          "replacement": "<abs-path>/"
+      }
+    ],
+    "ignorePatterns": [
+      {
+        "pattern": "^.+localhost.+$|\/.+yaml"
+      }
+    ]
+  }
+  

docs/.gitignore

@@ -0,0 +1,15 @@
+{
+    "MD009": false,
+    "MD012": false,
+    "MD010": false,
+    "MD013": false,
+    "MD004": {"style": "dash"},
+    "MD022": false,
+    "MD033": false,
+    "MD041": false,
+    "MD003": false,
+    "MD002": false,
+    "MD024": {"siblings_only": true},
+    "MD046": false
+  }
+  

docs/config/_default/config.toml

@@ -0,0 +1,34 @@
+[build]
+  base = "docs/"
+  publish = "public"
+
+[context.production]
+  command = "make all"   
+
+[context.docs-development]
+  command = "make all-dev"
+
+[context.docs-staging]
+  command = "make all-staging"
+
+[context.branch-deploy]
+  command = "make deploy-preview"
+
+[context.deploy-preview]
+  command = "make deploy-preview"
+
+[[headers]]
+  for = "/*"
+  [headers.values]
+    Access-Control-Allow-Origin = "https://docs.nginx.com"
+
+[[redirects]]
+  from = "/"
+  to = "/nginx-gateway-fabric/"
+  status = 301
+  force = true
+
+[[redirects]]
+  from = "/nginx-gateway-fabric/*"
+  to = "/nginx-gateway-fabric/404.html"
+  status = 404