Merge branch 'main' into im/hab_package_rn

IanMadd · web-flow · commit 91a91f631877 · 2024-11-19T09:02:42.000-05:00
diff --git a/_vendor/modules.txt b/_vendor/modules.txt
@@ -1,6 +1,6 @@
 # github.com/chef/automate/components/docs-chef-io v0.0.0-20240926130942-4b98d9cf92f6
 # github.com/chef/desktop-config/docs-chef-io v0.0.0-20240814044820-5af667d41a43
-# github.com/habitat-sh/habitat/components/docs-chef-io v0.0.0-20240410132404-ec6d25dc198b
+# github.com/habitat-sh/habitat/components/docs-chef-io v0.0.0-20241115181736-d7fefb1e7d23
 # github.com/chef/chef-server/docs-chef-io v0.0.0-20240920053744-03b58ff14f46
 # github.com/inspec/inspec/docs-chef-io v0.0.0-20241105131042-f05b389794c9
 # github.com/inspec/inspec-alicloud/docs-chef-io v0.0.0-20240122032124-a1d2a214e170
diff --git a/assets/release-notes/habitat/release-versions.json b/assets/release-notes/habitat/release-versions.json
@@ -37,5 +37,6 @@
   "1.6.607",
   "1.6.652",
   "1.6.826",
-  "1.6.1041"
+  "1.6.1041",
+  "1.6.1215"
 ]
diff --git a/config/_default/params.toml b/config/_default/params.toml
@@ -17,9 +17,20 @@ menuOrder = [
   "legacy",
   "extra"
 ]
+
 enable_search = true
 robots = ''
 
+# sitemaps lists sitemaps that are indexed by the main sitemap layout.
+# see:
+# - layouts/_default/sitemap.xml
+# - layouts/_default/home.sitemap-main.xml
+
+sitemaps = [
+  "https://docs.chef.io/sitemap-main.xml",
+  "https://docs.chef.io/360/1.0/sitemap.xml"
+]
+
 [chef-web-docs]
   gh_path = "https://github.com/chef/chef-web-docs/blob/main/content/"
 
diff --git a/content/habitat/habitat_cli.md b/content/habitat/habitat_cli.md
@@ -18,7 +18,7 @@ The commands for the Chef Habitat CLI (`hab`) are listed below.
 
 | Applies to Version | Last Updated |
 | ------- | ------------ |
-| hab 1.6.1041/20240411141804 (linux) | 11 Apr 2024 |
+| hab 1.6.1215/20241115182310 (linux) | 15 Nov 2024 |
 
 ## hab
 
@@ -96,7 +96,7 @@ hab bldr <SUBCOMMAND>
 | Command | Description |
 | ------- | ----------- |
 | [hab bldr channel](#hab-bldr-channel) | Commands relating to Habitat Builder channels |
-| [hab bldr job](#hab-bldr-job) | Commands relating to Habitat Builder jobs |
+| [hab bldr job](#hab-bldr-job) | REMOVED: Commands relating to Habitat Builder jobs |
 ---
 
 ### hab bldr channel
@@ -306,7 +306,7 @@ hab bldr channel promote [OPTIONS] <SOURCE_CHANNEL> <TARGET_CHANNEL> --origin <O
 
 ### hab bldr job
 
-Commands relating to Habitat Builder jobs
+REMOVED: Commands relating to Habitat Builder jobs
 
 **USAGE**
 
@@ -328,16 +328,16 @@ hab bldr job <SUBCOMMAND>
 
 | Command | Description |
 | ------- | ----------- |
-| [hab bldr job cancel](#hab-bldr-job-cancel) | Cancel a build job group and any in-progress builds |
-| [hab bldr job demote](#hab-bldr-job-demote) | Demote packages from a completed build job from a specified channel |
-| [hab bldr job promote](#hab-bldr-job-promote) | Promote packages from a completed build job to a specified channel |
-| [hab bldr job start](#hab-bldr-job-start) | Schedule a build job or group of jobs |
-| [hab bldr job status](#hab-bldr-job-status) | Get the status of one or more job groups |
+| [hab bldr job cancel](#hab-bldr-job-cancel) | REMOVED: Cancel a build job group and any in-progress builds |
+| [hab bldr job demote](#hab-bldr-job-demote) | REMOVED: Demote packages from a completed build job from a specified channel |
+| [hab bldr job promote](#hab-bldr-job-promote) | REMOVED: Promote packages from a completed build job to a specified channel |
+| [hab bldr job start](#hab-bldr-job-start) | REMOVED: Schedule a build job or group of jobs |
+| [hab bldr job status](#hab-bldr-job-status) | REMOVED: Get the status of one or more job groups |
 ---
 
 ### hab bldr job cancel
 
-Cancel a build job group and any in-progress builds
+REMOVED: Cancel a build job group and any in-progress builds
 
 **USAGE**
 
@@ -372,7 +372,7 @@ hab bldr job cancel [FLAGS] [OPTIONS] <GROUP_ID>
 
 ### hab bldr job demote
 
-Demote packages from a completed build job from a specified channel
+REMOVED: Demote packages from a completed build job from a specified channel
 
 **USAGE**
 
@@ -409,7 +409,7 @@ hab bldr job demote [FLAGS] [OPTIONS] <GROUP_ID> <CHANNEL>
 
 ### hab bldr job promote
 
-Promote packages from a completed build job to a specified channel
+REMOVED: Promote packages from a completed build job to a specified channel
 
 **USAGE**
 
@@ -446,7 +446,7 @@ hab bldr job promote [FLAGS] [OPTIONS] <GROUP_ID> <CHANNEL>
 
 ### hab bldr job start
 
-Schedule a build job or group of jobs
+REMOVED: Schedule a build job or group of jobs
 
 **USAGE**
 
@@ -482,7 +482,7 @@ hab bldr job start [FLAGS] [OPTIONS] <PKG_IDENT> [PKG_TARGET]
 
 ### hab bldr job status
 
-Get the status of one or more job groups
+REMOVED: Get the status of one or more job groups
 
 **USAGE**
 
@@ -1825,10 +1825,11 @@ hab pkg build [FLAGS] [OPTIONS] <PLAN_CONTEXT>
 **OPTIONS**
 
 ```
---cache-key-path <CACHE_KEY_PATH>    Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=]  [default: /hab/cache/keys]
--k, --keys <HAB_ORIGIN_KEYS>             Installs secret origin keys (ex: "unicorn", "acme,other,acme-ops")
--r, --root <HAB_STUDIO_ROOT>             Sets the Studio root (default: /hab/studios/<DIR_NAME>)
--s, --src <SRC_PATH>                     Sets the source path (default: $PWD)
+--cache-key-path <CACHE_KEY_PATH>      Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=]  [default: /hab/cache/keys]
+-k, --keys <HAB_ORIGIN_KEYS>               Installs secret origin keys (ex: "unicorn", "acme,other,acme-ops")
+-r, --root <HAB_STUDIO_ROOT>               Sets the Studio root (default: /hab/studios/<DIR_NAME>)
+-f, --refresh-channel <REFRESH_CHANNEL>    Channel used to retrieve plan dependencies for Chef supported origins env: HAB_REFRESH_CHANNEL=]  [default: stable]
+-s, --src <SRC_PATH>                       Sets the source path (default: $PWD)
 ```
 
 **ARGS**
@@ -2245,6 +2246,7 @@ hab pkg install [FLAGS] [OPTIONS] <PKG_IDENT_OR_ARTIFACT>...
 -b, --binlink                Binlink all binaries from installed package(s) into BINLINK_DIR
 -f, --force                  Overwrite existing binlinks
     --ignore-install-hook    Do not run any install hooks
+    --ignore-local           Do not use locally-installed packages when a corresponding package cannot be installed from Builder
 -h, --help                   Prints help information
 -V, --version                Prints version information
 ```
diff --git a/content/habitat/service_templates.md b/content/habitat/service_templates.md
@@ -1,7 +1,7 @@
 +++
 title = "Service Template Data"
 
-date = 2024-04-11T15:19:34.317Z
+date = 2024-11-15T19:26:21.695Z
 draft = false
 
 [menu]
diff --git a/content/versions.md b/content/versions.md
@@ -13,16 +13,14 @@ product = ["automate", "client", "server", "habitat", "inspec", "supermarket", "
     weight = 10
 +++
 
-This section lists the free and commercial Chef products and versions we
-currently support. The lifecycle stage defines the involvement by Chef
-Software in updating and maintaining each product.
+This section lists the free and commercial Chef products and versions we currently support.
+The lifecycle stage defines the involvement by Chef Software in updating and maintaining each product.
 
-## Lifecycle Definitions
+## Lifecycle definitions
 
 ### Generally Available (GA)
 
-This stage indicates that the product or version is in active
-development and/or maintenance.
+This stage indicates that the product or version is in active development and/or maintenance.
 
 - Chef continues to provide releases to the application or version in response to customer needs and security vulnerabilities
 - Chef welcomes customer feature requests for the product roadmap for the application
@@ -44,7 +42,7 @@ This stage indicates that Chef has set a date after which the
 application or version will no longer be supported or recommended for
 use by customers.
 
-### Versions and Status
+### Versions and status
 
 {{< important >}}
 
@@ -54,7 +52,7 @@ Unless otherwise stated, versions older than those listed below are EOL.
 
 {{< /important >}}
 
-## Supported Commercial Distributions
+## Supported commercial distributions
 
 Use of these and later versions of these distributions must be in
 accordance with the [Chef End User License
@@ -79,7 +77,7 @@ products.
 
 {{< /note >}}
 
-## Supported Free Distributions
+## Supported free distributions
 
 Use of the following distributions is governed by the Apache License,
 version 2.0.
@@ -88,20 +86,20 @@ version 2.0.
 |-------------|---------|------------------|----------|
 | Supermarket | 5.x     | GA               | TBD      |
 
-## Deprecated Products and Versions
+## Deprecated products and versions
 
 The following products are deprecated. Users are advised to move to
 newer versions or products.
 
-| Product           | Version | Lifecycle Status | EOL Date          |
-|-------------------|---------|------------------|-------------------|
-| Chef Backend      | 3.x     | Deprecated       | TBD               |
-| Chef Infra Client | 17.x    | Deprecated       | November 30, 2024 |
-| Chef Infra Server | 14.x    | Deprecated       | TBD               |
-| Chef InSpec       | 5.x     | Deprecated       | TBD               |
-| Chef Manage       | 2.5.x+  | Deprecated       | TBD               |
+| Product           | Version | Lifecycle Status | EOL Date       |
+|-------------------|---------|------------------|----------------|
+| Chef Backend      | 3.x     | Deprecated       | TBD            |
+| Chef Infra Client | 17.x    | Deprecated       | March 31, 2025 |
+| Chef Infra Server | 14.x    | Deprecated       | TBD            |
+| Chef InSpec       | 5.x     | Deprecated       | TBD            |
+| Chef Manage       | 2.5.x+  | Deprecated       | TBD            |
 
-## End of Life (EOL) Products
+## End of Life (EOL) products
 
 | Product                  | Version             | Lifecycle Status | EOL Date          |
 |--------------------------|---------------------|------------------|-------------------|
diff --git a/generated/config.toml b/generated/config.toml
@@ -1,6 +1,6 @@
 ## Config file for generated dir.
 
-disableKinds = [ "sitemap", "taxonomy", "term", "RSS", "sitemap"]
+disableKinds = [ "sitemap", "taxonomy", "term", "RSS"]
 publishDir = "generated_content"
 
 [module]
diff --git a/go.mod b/go.mod
@@ -14,7 +14,7 @@ require (
 	github.com/chef/license-service/docs-chef-io v0.0.0-20231117105514-d3f3d53ba2dd // indirect
 	github.com/chef/supermarket/docs-chef-io v0.0.0-20241105172430-a362eded8f72 // indirect
 	github.com/cowboy/jquery-hashchange v0.0.0-20100902193700-0310f3847f90 // indirect
-	github.com/habitat-sh/habitat/components/docs-chef-io v0.0.0-20240410132404-ec6d25dc198b // indirect
+	github.com/habitat-sh/habitat/components/docs-chef-io v0.0.0-20241115181736-d7fefb1e7d23 // indirect
 	github.com/inspec/inspec-alicloud/docs-chef-io v0.0.0-20240122032124-a1d2a214e170 // indirect
 	github.com/inspec/inspec-aws/docs-chef-io v0.0.0-20240122032232-049dcf822eef // indirect
 	github.com/inspec/inspec-azure/docs-chef-io v0.0.0-20240122032234-c1394fc25525 // indirect
diff --git a/go.sum b/go.sum
@@ -20,8 +20,8 @@ github.com/chef/supermarket/docs-chef-io v0.0.0-20241105172430-a362eded8f72 h1:m
 github.com/chef/supermarket/docs-chef-io v0.0.0-20241105172430-a362eded8f72/go.mod h1:D+9mmEZxCwpdhZ8LrEODBWMwMufmJUubSt5NlU/lLB4=
 github.com/cowboy/jquery-hashchange v0.0.0-20100902193700-0310f3847f90 h1:p/a5iSATj0OjrqJLX/YKxYdGXhZzW58yyyNIC4JY4S0=
 github.com/cowboy/jquery-hashchange v0.0.0-20100902193700-0310f3847f90/go.mod h1:N/6F0+wmdvL6k0AjqyKIncMRClKAN92atjZdTLtYMaw=
-github.com/habitat-sh/habitat/components/docs-chef-io v0.0.0-20240410132404-ec6d25dc198b h1:Ro7cUmzy6EEKQSUdIO+Avfw8qDIQitQUY/lVdD6Za2g=
-github.com/habitat-sh/habitat/components/docs-chef-io v0.0.0-20240410132404-ec6d25dc198b/go.mod h1:5GKz/BtTWeTr8vdVQPkvGDQkQ+xiGWLkDsPOXhu2Ps4=
+github.com/habitat-sh/habitat/components/docs-chef-io v0.0.0-20241115181736-d7fefb1e7d23 h1:yCEYVtJ1XB1g46HiUwsrww3ASB+jyhCoI/VWQe+2Exg=
+github.com/habitat-sh/habitat/components/docs-chef-io v0.0.0-20241115181736-d7fefb1e7d23/go.mod h1:5GKz/BtTWeTr8vdVQPkvGDQkQ+xiGWLkDsPOXhu2Ps4=
 github.com/inspec/inspec-alicloud/docs-chef-io v0.0.0-20240122032124-a1d2a214e170 h1:Q9jEEyv8nZAN5NgJXwMoqjngSz6Bc5ruNc9V72Hk4b4=
 github.com/inspec/inspec-alicloud/docs-chef-io v0.0.0-20240122032124-a1d2a214e170/go.mod h1:tAazDDBtR5yCl/FNWHnrmkxpfxnOo9B99DyfRE7JH1c=
 github.com/inspec/inspec-aws/docs-chef-io v0.0.0-20240122032232-049dcf822eef h1:r+GoVO6zbIAtusZ2w6MwUhtDAJicQkYbX0iWwZmuXfQ=
diff --git a/hugo.toml b/hugo.toml
@@ -7,24 +7,34 @@ pluralizeListTitles = false
 disableKinds = ["taxonomy", "term"]
 configDir = "config"
 
-# We do redirects using Netlify's _redirects file, generated by Hugo (see "outputs" below).
 disableAliases = true
 # Summary length
 summaryLength = 20
+
+# We do redirects using Netlify's _redirects file, generated by Hugo.
+# See the REDIR output and output format and the text/netlify mediatype.
 [outputs]
-home = [ "HTML", "RSS", "REDIR" ]
-section = [ "HTML", "RSS" ]
+  home = [ "HTML", "RSS", "REDIR", "SITEMAP-MAIN" ]
+  section = [ "HTML", "RSS" ]
 
 [mediaTypes]
-[mediaTypes."text/netlify"]
-delimiter = ""
+  [mediaTypes."text/netlify"]
+    delimiter = ""
 
 [outputFormats]
-[outputFormats.REDIR]
-mediatype = "text/netlify"
-baseName = "_redirects"
-isPlainText = true
-notAlternative = true
+  [outputFormats.REDIR]
+    mediatype = "text/netlify"
+    baseName = "_redirects"
+    isPlainText = true
+    notAlternative = true
+
+  [outputFormats.SITEMAP-MAIN]
+    MediaType = "application/xml"
+    BaseName = "sitemap-main"
+    IsHTML = false
+    IsPlainText = true
+    Rel = "sitemap"
+    protocol = "xml://"
 
 [markup]
   [markup.goldmark]
diff --git a/layouts/_default/home.sitemap-main.xml b/layouts/_default/home.sitemap-main.xml
@@ -0,0 +1,26 @@
+{{  printf "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?>" | safeHTML }}
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
+  xmlns:xhtml="http://www.w3.org/1999/xhtml">
+{{ range .Site.Pages }}
+  {{- if or (eq (isset .Params "sitemapexclude") false) (ne .Params.sitemapExclude true) }}
+    <url>
+      <loc>{{ .Permalink }}</loc>{{ if not .Lastmod.IsZero }}
+      <lastmod>{{ safeHTML ( .Lastmod.Format "2006-01-02T15:04:05-07:00" ) }}</lastmod>{{ end }}{{ with .Sitemap.ChangeFreq }}
+      <changefreq>{{ . }}</changefreq>{{ end }}{{ if ge .Sitemap.Priority 0.0 }}
+      <priority>{{ .Sitemap.Priority }}</priority>{{ end }}{{ if .IsTranslated }}{{ range .Translations }}
+      <xhtml:link
+                  rel="alternate"
+                  hreflang="{{ .Language.Lang }}"
+                  href="{{ .Permalink }}"
+                  />{{ end }}
+      <xhtml:link
+                  rel="alternate"
+                  hreflang="{{ .Language.Lang }}"
+                  href="{{ .Permalink }}"
+                  />{{ end }}
+    </url>
+  {{- end }}
+{{  end }}
+</urlset>
+
+<!-- From https://dereckcurry.com/posts/excluding-pages-from-the-sitemap/ -->
diff --git a/layouts/_default/sitemap.xml b/layouts/_default/sitemap.xml
@@ -0,0 +1,11 @@
+{{ printf "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\"?>" | safeHTML }}
+<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+{{- range .Site.Params.sitemaps }}
+  <sitemap>
+    <loc>{{ . }}</loc>
+  </sitemap>
+{{ end -}}
+</sitemapindex>
+
+<!-- https://developers.google.com/search/docs/crawling-indexing/sitemaps/large-sitemaps -->
+<!-- https://swiftype.com/documentation/site-search/crawler-configuration/sitemap -->

Original file line number	Diff line number	Diff line change
`@@ -37,5 +37,6 @@`
`37`	`37`	`"1.6.607",`
`38`	`38`	`"1.6.652",`
`39`	`39`	`"1.6.826",`
`40`		`- "1.6.1041"`
	`40`	`+ "1.6.1041",`
	`41`	`+ "1.6.1215"`
`41`	`42`	`]`