rename and regenerate all pages

fastly · Jan 26, 2021 · 0967738 · 0967738
1 parent 2671c9f
commit 0967738
Show file tree

Hide file tree

Showing 70 changed files with 197 additions and 23 deletions.
diff --git a/docs/data-sources/ip_ranges.md b/docs/data-sources/ip_ranges.md
@@ -0,0 +1,36 @@
+---
+layout: "fastly"
+page_title: "Fastly: fastly_ip_ranges"
+sidebar_current: "docs-fastly-datasource-ip_ranges"
+description: |-
+  Get information on Fastly IP ranges.
+---
+
+# fastly_ip_ranges
+
+Use this data source to get the [IP ranges][1] of Fastly edge nodes.
+
+## Example Usage
+
+```hcl
+data "fastly_ip_ranges" "fastly" {}
+
+resource "aws_security_group" "from_fastly" {
+  name = "from_fastly"
+
+  ingress {
+    from_port         = "443"
+    to_port           = "443"
+    protocol          = "tcp"
+    cidr_blocks       = ["${data.fastly_ip_ranges.fastly.cidr_blocks}"]
+    ipv6_cidr_blocks  = ["${data.fastly_ip_ranges.fastly.ipv6_cidr_blocks}"]
+  }
+}
+```
+
+## Attributes Reference
+
+* `cidr_blocks` - The lexically ordered list of ipv4 CIDR blocks.
+* `ipv6_cidr_blocks` - The lexically ordered list of ipv6 CIDR blocks.
+
+[1]: https://docs.fastly.com/guides/securing-communications/accessing-fastlys-ip-ranges
diff --git a/docs/data-sources/waf_rules.md b/docs/data-sources/waf_rules.md
@@ -0,0 +1,148 @@
+---
+layout: "fastly"
+page_title: "Fastly: fastly_waf_rules"
+sidebar_current: "docs-fastly-datasource-waf_rules"
+description: |-
+  Get information on Fastly WAF rules.
+---
+
+-> **Note:** This data source is only available from 0.20.0 of the Fastly terraform provider.
+
+# fastly_waf_rules
+
+Use this data source to get the [WAF rules][1] of Fastly. A set of third-party rules from the OWASP Core Ruleset, commercial sources, and open source, in addition to Fastly-generated rules.
+They offer protection from injection attacks and cross site scripting amongst other key application-layer attacks.
+
+## Example Usage
+
+Usage with publishers Filter:
+
+```hcl
+data "fastly_waf_rules" "owasp" {
+  publishers = ["owasp"]
+}
+```
+
+Usage with tags filter:
+
+```hcl
+data "fastly_waf_rules" "tag" {
+  tags = ["language-html", "language-jsp"]
+}
+```
+
+Usage with exclude filter:
+
+```hcl
+data "fastly_waf_rules" "owasp_with_exclusions" {
+  publishers = ["owasp"]
+  exclude_modsec_rule_ids = [1010090]
+}
+```
+
+Usage without filters:
+
+```hcl
+data "fastly_waf_rules" "all" {
+  # This will retrieve the entire list of rules available from the API at the time.
+}
+```
+
+Usage with WAF configuration resource:
+
+```hcl
+variable "type_status" {
+  type = map(string)
+  default = {
+    score     = "score"
+    threshold = "log"
+    strict    = "log"
+  }
+}
+
+resource "fastly_service_v1" "demo" {
+  name = "demofastly"
+
+  domain {
+    name    = "example.com"
+    comment = "demo"
+  }
+
+  backend {
+    address = "127.0.0.1"
+    name    = "origin1"
+    port    = 80
+  }
+
+  condition {
+    name      = "WAF_Prefetch"
+    type      = "PREFETCH"
+    statement = "req.backend.is_origin"
+  }
+
+  # This condition will always be false
+  # adding it to the response object created below
+  # prevents Fastly from returning a 403 on all of your traffic.
+  condition {
+    name      = "WAF_always_false"
+    statement = "false"
+    type      = "REQUEST"
+  }
+
+  response_object {
+    name              = "WAF_Response"
+    status            = "403"
+    response          = "Forbidden"
+    content_type      = "text/html"
+    content           = "<html><body>Forbidden</body></html>"
+    request_condition = "WAF_always_false"
+  }
+
+  waf {
+    prefetch_condition = "WAF_Prefetch"
+    response_object    = "WAF_Response"
+  }
+
+  force_destroy = true
+}
+
+data "fastly_waf_rules" "owasp" {
+  publishers = ["owasp"]
+}
+
+resource "fastly_service_waf_configuration" "waf" {
+  waf_id                          = fastly_service_v1.demo.waf[0].waf_id
+  http_violation_score_threshold  = 100
+
+  dynamic "rule" {
+    for_each = data.fastly_waf_rules.owasp.rules
+    content {
+      modsec_rule_id = rule.value.modsec_rule_id
+      revision       = rule.value.latest_revision_number
+      status         = lookup(var.type_status, rule.value.type, "log")
+    }
+  }
+}
+```
+
+## Argument Reference
+
+~> **Warning:** The data source's filters are applied using an **AND** boolean operator, so depending on the combination of filters, they may become mutually exclusive.
+
+* `publishers` - Inclusion filter by WAF rule's publishers.
+* `tags` - Inclusion filter by WAF rule's tags.
+* `exclude_modsec_rule_ids` - Exclusion filter by WAF rule's ModSecurity ID.
+
+## Attribute Reference
+
+* `rules` - The Web Application Firewall's rules result set.
+
+~> **Warning:** Deprecated rules will not be present on this data source's result set.
+
+The `rules` block supports:
+
+* `modsec_rule_id` - The rule's modsecurity ID.
+* `latest_revision_number` - The rule's latest revision.
+* `type` - The rule's type.
+
+[1]: https://developer.fastly.com/reference/api/waf/rules/
diff --git a/...rces/service_acl_entries_v1.html.markdown → docs/resources/service_acl_entries_v1.md b/...rces/service_acl_entries_v1.html.markdown → docs/resources/service_acl_entries_v1.md
diff --git a/docs/resources/service_compute.html.markdown → docs/resources/service_compute.md b/docs/resources/service_compute.html.markdown → docs/resources/service_compute.md
diff --git a/...service_dictionary_items_v1.html.markdown → .../resources/service_dictionary_items_v1.md b/...service_dictionary_items_v1.html.markdown → .../resources/service_dictionary_items_v1.md
diff --git a/..._dynamic_snippet_content_v1.html.markdown → ...ces/service_dynamic_snippet_content_v1.md b/..._dynamic_snippet_content_v1.html.markdown → ...ces/service_dynamic_snippet_content_v1.md
diff --git a/docs/resources/service_v1.html.markdown → docs/resources/service_v1.md b/docs/resources/service_v1.html.markdown → docs/resources/service_v1.md
diff --git a/...s/service_waf_configuration.html.markdown → docs/resources/service_waf_configuration.md b/...s/service_waf_configuration.html.markdown → docs/resources/service_waf_configuration.md
diff --git a/docs/resources/user_v1.html.markdown → docs/resources/user_v1.md b/docs/resources/user_v1.html.markdown → docs/resources/user_v1.md
diff --git a/...data-sources/ip_ranges.html.markdown.tmpl → docs_src/data-sources/ip_ranges.md.tmpl b/...data-sources/ip_ranges.html.markdown.tmpl → docs_src/data-sources/ip_ranges.md.tmpl
@@ -1,4 +1,4 @@
-{{define "fastly_ip_ranges"}}---
+{{define "ip_ranges"}}---
 layout: "fastly"
 page_title: "Fastly: fastly_ip_ranges"
 sidebar_current: "docs-fastly-datasource-ip_ranges"

diff --git a/...data-sources/waf_rules.html.markdown.tmpl → docs_src/data-sources/waf_rules.md.tmpl b/...data-sources/waf_rules.html.markdown.tmpl → docs_src/data-sources/waf_rules.md.tmpl
@@ -1,4 +1,4 @@
-{{define "fastly_waf_rules"}}---
+{{define "waf_rules"}}---
 layout: "fastly"
 page_title: "Fastly: fastly_waf_rules"
 sidebar_current: "docs-fastly-datasource-waf_rules"

diff --git a/...src/resources/arguments/acl.markdown.tmpl → docs_src/resources/arguments/acl.md.tmpl b/...src/resources/arguments/acl.markdown.tmpl → docs_src/resources/arguments/acl.md.tmpl
diff --git a/...esources/arguments/activate.markdown.tmpl → ..._src/resources/arguments/activate.md.tmpl b/...esources/arguments/activate.markdown.tmpl → ..._src/resources/arguments/activate.md.tmpl
diff --git a/...resources/arguments/backend.markdown.tmpl → docs_src/resources/arguments/backend.md.tmpl b/...resources/arguments/backend.markdown.tmpl → docs_src/resources/arguments/backend.md.tmpl
diff --git a/...s/arguments/bigquerylogging.markdown.tmpl → ...sources/arguments/bigquerylogging.md.tmpl b/...s/arguments/bigquerylogging.markdown.tmpl → ...sources/arguments/bigquerylogging.md.tmpl
diff --git a/...rguments/blobstoragelogging.markdown.tmpl → ...rces/arguments/blobstoragelogging.md.tmpl b/...rguments/blobstoragelogging.markdown.tmpl → ...rces/arguments/blobstoragelogging.md.tmpl
diff --git a/...ces/arguments/cache_setting.markdown.tmpl → ...resources/arguments/cache_setting.md.tmpl b/...ces/arguments/cache_setting.markdown.tmpl → ...resources/arguments/cache_setting.md.tmpl
diff --git a/...resources/arguments/comment.markdown.tmpl → docs_src/resources/arguments/comment.md.tmpl b/...resources/arguments/comment.markdown.tmpl → docs_src/resources/arguments/comment.md.tmpl
diff --git a/...sources/arguments/condition.markdown.tmpl → ...src/resources/arguments/condition.md.tmpl b/...sources/arguments/condition.markdown.tmpl → ...src/resources/arguments/condition.md.tmpl
diff --git a/...rces/arguments/default_host.markdown.tmpl → .../resources/arguments/default_host.md.tmpl b/...rces/arguments/default_host.markdown.tmpl → .../resources/arguments/default_host.md.tmpl
diff --git a/...urces/arguments/default_ttl.markdown.tmpl → ...c/resources/arguments/default_ttl.md.tmpl b/...urces/arguments/default_ttl.markdown.tmpl → ...c/resources/arguments/default_ttl.md.tmpl
diff --git a/...ources/arguments/dictionary.markdown.tmpl → ...rc/resources/arguments/dictionary.md.tmpl b/...ources/arguments/dictionary.markdown.tmpl → ...rc/resources/arguments/dictionary.md.tmpl
diff --git a/...esources/arguments/director.markdown.tmpl → ..._src/resources/arguments/director.md.tmpl b/...esources/arguments/director.markdown.tmpl → ..._src/resources/arguments/director.md.tmpl
diff --git a/.../resources/arguments/domain.markdown.tmpl → docs_src/resources/arguments/domain.md.tmpl b/.../resources/arguments/domain.markdown.tmpl → docs_src/resources/arguments/domain.md.tmpl
diff --git a/...es/arguments/dynamicsnippet.markdown.tmpl → ...esources/arguments/dynamicsnippet.md.tmpl b/...es/arguments/dynamicsnippet.markdown.tmpl → ...esources/arguments/dynamicsnippet.md.tmpl
diff --git a/...ces/arguments/force_destroy.markdown.tmpl → ...resources/arguments/force_destroy.md.tmpl b/...ces/arguments/force_destroy.markdown.tmpl → ...resources/arguments/force_destroy.md.tmpl
diff --git a/...ources/arguments/gcslogging.markdown.tmpl → ...rc/resources/arguments/gcslogging.md.tmpl b/...ources/arguments/gcslogging.markdown.tmpl → ...rc/resources/arguments/gcslogging.md.tmpl
diff --git a/...rc/resources/arguments/gzip.markdown.tmpl → docs_src/resources/arguments/gzip.md.tmpl b/...rc/resources/arguments/gzip.markdown.tmpl → docs_src/resources/arguments/gzip.md.tmpl
diff --git a/.../resources/arguments/header.markdown.tmpl → docs_src/resources/arguments/header.md.tmpl b/.../resources/arguments/header.markdown.tmpl → docs_src/resources/arguments/header.md.tmpl
diff --git a/...urces/arguments/healthcheck.markdown.tmpl → ...c/resources/arguments/healthcheck.md.tmpl b/...urces/arguments/healthcheck.markdown.tmpl → ...c/resources/arguments/healthcheck.md.tmpl
diff --git a/...rces/arguments/httpslogging.markdown.tmpl → .../resources/arguments/httpslogging.md.tmpl b/...rces/arguments/httpslogging.markdown.tmpl → .../resources/arguments/httpslogging.md.tmpl
diff --git a/...ources/arguments/logentries.markdown.tmpl → ...rc/resources/arguments/logentries.md.tmpl b/...ources/arguments/logentries.markdown.tmpl → ...rc/resources/arguments/logentries.md.tmpl
diff --git a/...rguments/logging_cloudfiles.markdown.tmpl → ...rces/arguments/logging_cloudfiles.md.tmpl b/...rguments/logging_cloudfiles.markdown.tmpl → ...rces/arguments/logging_cloudfiles.md.tmpl
diff --git a/...s/arguments/logging_datadog.markdown.tmpl → ...sources/arguments/logging_datadog.md.tmpl b/...s/arguments/logging_datadog.markdown.tmpl → ...sources/arguments/logging_datadog.md.tmpl
diff --git a/...uments/logging_digitalocean.markdown.tmpl → ...es/arguments/logging_digitalocean.md.tmpl b/...uments/logging_digitalocean.markdown.tmpl → ...es/arguments/logging_digitalocean.md.tmpl
diff --git a/...ments/logging_elasticsearch.markdown.tmpl → ...s/arguments/logging_elasticsearch.md.tmpl b/...ments/logging_elasticsearch.markdown.tmpl → ...s/arguments/logging_elasticsearch.md.tmpl
diff --git a/...urces/arguments/logging_ftp.markdown.tmpl → ...c/resources/arguments/logging_ftp.md.tmpl b/...urces/arguments/logging_ftp.markdown.tmpl → ...c/resources/arguments/logging_ftp.md.tmpl
diff --git a/...uments/logging_googlepubsub.markdown.tmpl → ...es/arguments/logging_googlepubsub.md.tmpl b/...uments/logging_googlepubsub.markdown.tmpl → ...es/arguments/logging_googlepubsub.md.tmpl
diff --git a/...es/arguments/logging_heroku.markdown.tmpl → ...esources/arguments/logging_heroku.md.tmpl b/...es/arguments/logging_heroku.markdown.tmpl → ...esources/arguments/logging_heroku.md.tmpl
diff --git a/...arguments/logging_honeycomb.markdown.tmpl → ...urces/arguments/logging_honeycomb.md.tmpl b/...arguments/logging_honeycomb.markdown.tmpl → ...urces/arguments/logging_honeycomb.md.tmpl
diff --git a/...ces/arguments/logging_kafka.markdown.tmpl → ...resources/arguments/logging_kafka.md.tmpl b/...ces/arguments/logging_kafka.markdown.tmpl → ...resources/arguments/logging_kafka.md.tmpl
diff --git a/...s/arguments/logging_kinesis.markdown.tmpl → ...sources/arguments/logging_kinesis.md.tmpl b/...s/arguments/logging_kinesis.markdown.tmpl → ...sources/arguments/logging_kinesis.md.tmpl
diff --git a/...es/arguments/logging_loggly.markdown.tmpl → ...esources/arguments/logging_loggly.md.tmpl b/...es/arguments/logging_loggly.markdown.tmpl → ...esources/arguments/logging_loggly.md.tmpl
diff --git a/...rguments/logging_logshuttle.markdown.tmpl → ...rces/arguments/logging_logshuttle.md.tmpl b/...rguments/logging_logshuttle.markdown.tmpl → ...rces/arguments/logging_logshuttle.md.tmpl
diff --git a/.../arguments/logging_newrelic.markdown.tmpl → ...ources/arguments/logging_newrelic.md.tmpl b/.../arguments/logging_newrelic.markdown.tmpl → ...ources/arguments/logging_newrelic.md.tmpl
diff --git a/...arguments/logging_openstack.markdown.tmpl → ...urces/arguments/logging_openstack.md.tmpl b/...arguments/logging_openstack.markdown.tmpl → ...urces/arguments/logging_openstack.md.tmpl
diff --git a/...es/arguments/logging_scalyr.markdown.tmpl → ...esources/arguments/logging_scalyr.md.tmpl b/...es/arguments/logging_scalyr.markdown.tmpl → ...esources/arguments/logging_scalyr.md.tmpl
diff --git a/...rces/arguments/logging_sftp.markdown.tmpl → .../resources/arguments/logging_sftp.md.tmpl b/...rces/arguments/logging_sftp.markdown.tmpl → .../resources/arguments/logging_sftp.md.tmpl
diff --git a/...rc/resources/arguments/name.markdown.tmpl → docs_src/resources/arguments/name.md.tmpl b/...rc/resources/arguments/name.markdown.tmpl → docs_src/resources/arguments/name.md.tmpl
diff --git a/...resources/arguments/package.markdown.tmpl → docs_src/resources/arguments/package.md.tmpl b/...resources/arguments/package.markdown.tmpl → docs_src/resources/arguments/package.md.tmpl
diff --git a/...ources/arguments/papertrail.markdown.tmpl → ...rc/resources/arguments/papertrail.md.tmpl b/...ources/arguments/papertrail.markdown.tmpl → ...rc/resources/arguments/papertrail.md.tmpl
diff --git a/...s/arguments/request_setting.markdown.tmpl → ...sources/arguments/request_setting.md.tmpl b/...s/arguments/request_setting.markdown.tmpl → ...sources/arguments/request_setting.md.tmpl
diff --git a/...s/arguments/response_object.markdown.tmpl → ...sources/arguments/response_object.md.tmpl b/...s/arguments/response_object.markdown.tmpl → ...sources/arguments/response_object.md.tmpl
diff --git a/...sources/arguments/s3logging.markdown.tmpl → ...src/resources/arguments/s3logging.md.tmpl b/...sources/arguments/s3logging.markdown.tmpl → ...src/resources/arguments/s3logging.md.tmpl
diff --git a/...resources/arguments/snippet.markdown.tmpl → docs_src/resources/arguments/snippet.md.tmpl b/...resources/arguments/snippet.markdown.tmpl → docs_src/resources/arguments/snippet.md.tmpl
diff --git a/.../resources/arguments/splunk.markdown.tmpl → docs_src/resources/arguments/splunk.md.tmpl b/.../resources/arguments/splunk.markdown.tmpl → docs_src/resources/arguments/splunk.md.tmpl
diff --git a/...sources/arguments/sumologic.markdown.tmpl → ...src/resources/arguments/sumologic.md.tmpl b/...sources/arguments/sumologic.markdown.tmpl → ...src/resources/arguments/sumologic.md.tmpl
diff --git a/.../resources/arguments/syslog.markdown.tmpl → docs_src/resources/arguments/syslog.md.tmpl b/.../resources/arguments/syslog.markdown.tmpl → docs_src/resources/arguments/syslog.md.tmpl
diff --git a/...src/resources/arguments/vcl.markdown.tmpl → docs_src/resources/arguments/vcl.md.tmpl b/...src/resources/arguments/vcl.markdown.tmpl → docs_src/resources/arguments/vcl.md.tmpl
diff --git a/...s/arguments/version_comment.markdown.tmpl → ...sources/arguments/version_comment.md.tmpl b/...s/arguments/version_comment.markdown.tmpl → ...sources/arguments/version_comment.md.tmpl
diff --git a/...ces/components/export_intro.markdown.tmpl → ...resources/components/export_intro.md.tmpl b/...ces/components/export_intro.markdown.tmpl → ...resources/components/export_intro.md.tmpl
diff --git a/...resources/components/footer.markdown.tmpl → docs_src/resources/components/footer.md.tmpl b/...resources/components/footer.markdown.tmpl → docs_src/resources/components/footer.md.tmpl
diff --git a/...service_acl_entries_v1.html.markdown.tmpl → .../resources/service_acl_entries_v1.md.tmpl b/...service_acl_entries_v1.html.markdown.tmpl → .../resources/service_acl_entries_v1.md.tmpl
diff --git a/...ources/service_compute.html.markdown.tmpl → docs_src/resources/service_compute.md.tmpl b/...ources/service_compute.html.markdown.tmpl → docs_src/resources/service_compute.md.tmpl
diff --git a/...ce_dictionary_items_v1.html.markdown.tmpl → ...urces/service_dictionary_items_v1.md.tmpl b/...ce_dictionary_items_v1.html.markdown.tmpl → ...urces/service_dictionary_items_v1.md.tmpl
diff --git a/...mic_snippet_content_v1.html.markdown.tmpl → ...ervice_dynamic_snippet_content_v1.md.tmpl b/...mic_snippet_content_v1.html.markdown.tmpl → ...ervice_dynamic_snippet_content_v1.md.tmpl
diff --git a/...c/resources/service_v1.html.markdown.tmpl → docs_src/resources/service_v1.md.tmpl b/...c/resources/service_v1.html.markdown.tmpl → docs_src/resources/service_v1.md.tmpl
diff --git a/...vice_waf_configuration.html.markdown.tmpl → ...sources/service_waf_configuration.md.tmpl b/...vice_waf_configuration.html.markdown.tmpl → ...sources/service_waf_configuration.md.tmpl
diff --git a/..._src/resources/user_v1.html.markdown.tmpl → docs_src/resources/user_v1.md.tmpl b/..._src/resources/user_v1.html.markdown.tmpl → docs_src/resources/user_v1.md.tmpl
diff --git a/scripts/website/parse-templates.go b/scripts/website/parse-templates.go
@@ -37,63 +37,52 @@ func main() {
 	var dataPages = []Page{
 		{
 			name: "ip_ranges",
-			path: docsDir + "data-sources/ip_ranges.html.markdown",
+			path: docsDir + "data-sources/ip_ranges.md",
 		},
 		{
 			name: "waf_rules",
-			path: docsDir + "data-sources/waf_rules.html.markdown",
+			path: docsDir + "data-sources/waf_rules.md",
 		},
 	}
 
 	var resourcePages = []Page{
 		{
 			name: "service_v1",
-			path: docsDir + "resources/service_v1.html.markdown",
+			path: docsDir + "resources/service_v1.md",
 			Data: PageData{
 				"vcl",
 			},
 		},
 		{
 			name: "service_compute",
-			path: docsDir + "resources/service_compute.html.markdown",
+			path: docsDir + "resources/service_compute.md",
 			Data: PageData{
 				"wasm",
 			},
 		},
 		{
 			name: "service_dictionary_items_v1",
-			path: docsDir + "resources/service_dictionary_items_v1.html.markdown",
+			path: docsDir + "resources/service_dictionary_items_v1.md",
 		},
 		{
 			name: "service_acl_entries_v1",
-			path: docsDir + "resources/service_acl_entries_v1.html.markdown",
+			path: docsDir + "resources/service_acl_entries_v1.md",
 		},
 		{
 			name: "service_dynamic_snippet_content_v1",
-			path: docsDir + "resources/service_dynamic_snippet_content_v1.html.markdown",
+			path: docsDir + "resources/service_dynamic_snippet_content_v1.md",
 		},
 		{
 			name: "service_waf_configuration",
-			path: docsDir + "resources/service_waf_configuration.html.markdown",
+			path: docsDir + "resources/service_waf_configuration.md",
 		},
 		{
 			name: "user_v1",
-			path: docsDir + "resources/user_v1.html.markdown",
+			path: docsDir + "resources/user_v1.md",
 		},
 	}
 
-	// TODO(integralist): redesign the template parsing so that we don't need
-	// a root node of the pages tree structure. Historically the 'no-op' file
-	// would have referenced a fastly_erb/fastly.erb file containing a Ruby based
-	// HTML template file (as the terraform.io used to run on a Ruby platform).
-	// This file would define the HTML for a side-menu bar that linked to other
-	// pages and resources.
-	var pages = append(resourcePages, Page{
-		name:         "no-op",
-		path:         docsDir + "no_op",
-		DataMenu:     generateMenuItems("data-sources", dataPages),
-		ResourceMenu: generateMenuItems("resources", resourcePages),
-	})
+	pages := append(resourcePages, dataPages...)
 
 	renderPages(getTemplate(tmplDir), pages)
 }
@@ -136,6 +125,7 @@ func getTemplate(tmplDir string) *template.Template {
 		}
 		return nil
 	})
+	fmt.Println(templateFiles)
 	return template.Must(template.ParseFiles(templateFiles...))
 }