Publish docs from f48ea1b

404.html

@@ -339,7 +339,7 @@
 
 
  <li class="md-nav__item">
- <a href="/branch_planner/index.md" class="md-nav__link">
+ <a href="/branch_planner/" class="md-nav__link">
 
 
  <span class="md-ellipsis">

References/terraform/index.html

@@ -343,7 +343,7 @@
 
 
  <li class="md-nav__item">
- <a href="../../branch_planner/index.md" class="md-nav__link">
+ <a href="../../branch_planner/" class="md-nav__link">
 
 
  <span class="md-ellipsis">

adr/0000-template/index.html

@@ -344,7 +344,7 @@
 
 
  <li class="md-nav__item">
- <a href="../../branch_planner/index.md" class="md-nav__link">
+ <a href="../../branch_planner/" class="md-nav__link">
 
 
  <span class="md-ellipsis">

adr/0000-use-adrs-for-decisions/index.html

@@ -344,7 +344,7 @@
 
 
  <li class="md-nav__item">
- <a href="../../branch_planner/index.md" class="md-nav__link">
+ <a href="../../branch_planner/" class="md-nav__link">
 
 
  <span class="md-ellipsis">

adr/0001-pr-polling-workflow/index.html

@@ -344,7 +344,7 @@
 
 
  <li class="md-nav__item">
- <a href="../../branch_planner/index.md" class="md-nav__link">
+ <a href="../../branch_planner/" class="md-nav__link">
 
 
  <span class="md-ellipsis">

adr/0002-deny-cross-ns-by-default/index.html

@@ -344,7 +344,7 @@
 
 
  <li class="md-nav__item">
- <a href="../../branch_planner/index.md" class="md-nav__link">
+ <a href="../../branch_planner/" class="md-nav__link">
 
 
  <span class="md-ellipsis">

adr/0003-workspace-blob-caching/index.html

@@ -344,7 +344,7 @@
 
 
  <li class="md-nav__item">
- <a href="../../branch_planner/index.md" class="md-nav__link">
+ <a href="../../branch_planner/" class="md-nav__link">
 
 
  <span class="md-ellipsis">

branch_planner/branch-planner-getting-started/index.html

@@ -344,7 +344,7 @@
 
 
  <li class="md-nav__item">
- <a href="../index.md" class="md-nav__link">
+ <a href="../" class="md-nav__link">
 
 
  <span class="md-ellipsis">

branch_planner/branch-planner-tfc-integration-getting-started/index.html

@@ -344,7 +344,7 @@
 
 
  <li class="md-nav__item">
- <a href="../index.md" class="md-nav__link">
+ <a href="../" class="md-nav__link">
 
 
  <span class="md-ellipsis">

branch_planner/branch-planner-overview/index.html → branch_planner/index.html

@@ -9,21 +9,25 @@
 
 
 
+ <link rel="prev" href="../use_tf_controller/">
 
 
- <link rel="icon" href="../../assets/images/favicon.png">
+ <link rel="next" href="../how_to/">
+
+
+ <link rel="icon" href="../assets/images/favicon.png">
  <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.4.14">
 
 
 
- <title>Branch Planner Overview - Weave GitOps Terraform Controller</title>
+ <title>User Guide - Weave GitOps Terraform Controller</title>
 
 
 
- <link rel="stylesheet" href="../../assets/stylesheets/main.fad675c6.min.css">
+ <link rel="stylesheet" href="../assets/stylesheets/main.fad675c6.min.css">
 
 
- <link rel="stylesheet" href="../../assets/stylesheets/palette.356b1318.min.css">
+ <link rel="stylesheet" href="../assets/stylesheets/palette.356b1318.min.css">
 
 
 
@@ -42,7 +46,7 @@
 
 
 
- <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+ <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
 
 
 
@@ -87,7 +91,7 @@
 
 <header class="md-header md-header--shadow" data-md-component="header">
  <nav class="md-header__inner md-grid" aria-label="Header">
- <a href="../.." title="Weave GitOps Terraform Controller" class="md-header__button md-logo" aria-label="Weave GitOps Terraform Controller" data-md-component="logo">
+ <a href=".." title="Weave GitOps Terraform Controller" class="md-header__button md-logo" aria-label="Weave GitOps Terraform Controller" data-md-component="logo">
 
 
  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
@@ -107,7 +111,7 @@
  <div class="md-header__topic" data-md-component="header-topic">
  <span class="md-ellipsis">
 
- Branch Planner Overview
+ User Guide
 
  </span>
  </div>
@@ -217,7 +221,7 @@
 
 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  <label class="md-nav__title" for="__drawer">
- <a href="../.." title="Weave GitOps Terraform Controller" class="md-nav__button md-logo" aria-label="Weave GitOps Terraform Controller" data-md-component="logo">
+ <a href=".." title="Weave GitOps Terraform Controller" class="md-nav__button md-logo" aria-label="Weave GitOps Terraform Controller" data-md-component="logo">
 
 
  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
@@ -247,7 +251,7 @@
 
 
  <li class="md-nav__item">
- <a href="../.." class="md-nav__link">
+ <a href=".." class="md-nav__link">
 
 
  <span class="md-ellipsis">
@@ -267,7 +271,7 @@
 
 
  <li class="md-nav__item">
- <a href="../../getting_started/" class="md-nav__link">
+ <a href="../getting_started/" class="md-nav__link">
 
 
  <span class="md-ellipsis">
@@ -287,7 +291,7 @@
 
 
  <li class="md-nav__item">
- <a href="../../use_tf_controller/" class="md-nav__link">
+ <a href="../use_tf_controller/" class="md-nav__link">
 
 
  <span class="md-ellipsis">
@@ -304,19 +308,21 @@
 
 
 
+
+
 
 
 
 
 
 
 
- <li class="md-nav__item md-nav__item--nested">
+ <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 
 
 
 
- <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
 
 
  <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
@@ -330,7 +336,7 @@
  <span class="md-nav__icon md-icon"></span>
  </label>
 
- <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
  <label class="md-nav__title" for="__nav_4">
  <span class="md-nav__icon md-icon"></span>
  Branch Planner
@@ -341,10 +347,30 @@
 
 
 
+
 
 
- <li class="md-nav__item">
- <a href="../index.md" class="md-nav__link">
+
+ <li class="md-nav__item md-nav__item--active">
+
+ <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
+
+
+
+
+
+ <label class="md-nav__link md-nav__link--active" for="__toc">
+
+
+ <span class="md-ellipsis">
+ User Guide
+ </span>
+
+
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <a href="./" class="md-nav__link md-nav__link--active">
 
 
  <span class="md-ellipsis">
@@ -353,6 +379,35 @@
 
 
  </a>
+
+
+
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+
+
+
+
+
+
+ <label class="md-nav__title" for="__toc">
+ <span class="md-nav__icon md-icon"></span>
+ Table of contents
+ </label>
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+
+ <li class="md-nav__item">
+ <a href="#replan-commands" class="md-nav__link">
+ <span class="md-ellipsis">
+ Replan commands
+ </span>
+ </a>
+
+</li>
+
+ </ul>
+
+</nav>
+
  </li>
 
 
@@ -365,7 +420,7 @@
 
 
  <li class="md-nav__item">
- <a href="../getting-started.md" class="md-nav__link">
+ <a href="getting-started.md" class="md-nav__link">
 
 
  <span class="md-ellipsis">
@@ -386,7 +441,7 @@
 
 
  <li class="md-nav__item">
- <a href="../least-required-permissions.md" class="md-nav__link">
+ <a href="least-required-permissions.md" class="md-nav__link">
 
 
  <span class="md-ellipsis">
@@ -407,7 +462,7 @@
 
 
  <li class="md-nav__item">
- <a href="../tfc-integration.md" class="md-nav__link">
+ <a href="tfc-integration.md" class="md-nav__link">
 
 
  <span class="md-ellipsis">
@@ -435,7 +490,7 @@
 
 
  <li class="md-nav__item">
- <a href="../../how_to/" class="md-nav__link">
+ <a href="../how_to/" class="md-nav__link">
 
 
  <span class="md-ellipsis">
@@ -455,7 +510,7 @@
 
 
  <li class="md-nav__item">
- <a href="../../References/terraform/" class="md-nav__link">
+ <a href="../References/terraform/" class="md-nav__link">
 
 
  <span class="md-ellipsis">
@@ -475,7 +530,7 @@
 
 
  <li class="md-nav__item">
- <a href="../../tfctl/" class="md-nav__link">
+ <a href="../tfctl/" class="md-nav__link">
 
 
  <span class="md-ellipsis">
@@ -544,10 +599,10 @@
 <h1 id="branch-planner-overview">Branch Planner Overview</h1>
 <p>The GitOps methodology streamlines infrastructure provisioning and management, using Git as the source of truth. The Branch Planner, a component of TF-Controller, aims to take this a step further by allowing developers and operations teams to plan Terraform configurations on a branch that's separate from the <code>main</code> branch. This makes it easier to review and understand the potential impact of your changes before you run <code>terraform apply</code>.</p>
 <p>The Branch Planner's most important feature is its seamless integration with the PR (Pull Request) user interface. When enabled through Helm values, it watches repositories that contain Terraform resources at regular intervals—checking their referenced Source, and polling for Pull Requests using GitHub's API and the provided token. When changes are proposed on a new branch, Branch Planner runs a plan in the cluster and displays the results directly as comments on your PR. Once you're satisfied with the results, you can merge your branch into the <code>main</code> branch to trigger the TF-Controller to reconcile the updated code.</p>
-<p><img alt="branch planner" src="../branch-planner.png" /></p>
+<p><img alt="branch planner" src="branch-planner.png" /></p>
 <h3 id="replan-commands">Replan commands</h3>
 <p>The Branch Planner also allows users to manually trigger the replan process. By simply commenting <code>!replan</code> under the PR, the Branch Planner will be instructed to generate a new plan and post it under the PR as a new comment.</p>
-<p>Now that you know what Branch Planner can do for you, follow the <a href="../branch-planner-getting-started/">guide to get started</a>.</p>
+<p>Now that you know what Branch Planner can do for you, follow the <a href="branch-planner-getting-started/">guide to get started</a>.</p>
 
 
 
@@ -586,10 +641,10 @@ <h3 id="replan-commands">Replan commands</h3>
  </div>
 
 
- <script id="__config" type="application/json">{"base": "../..", "features": ["content.code.annotate", "content.code.copy"], "search": "../../assets/javascripts/workers/search.f886a092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
+ <script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "content.code.copy"], "search": "../assets/javascripts/workers/search.f886a092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
- <script src="../../assets/javascripts/bundle.cd18aaf1.min.js"></script>
+ <script src="../assets/javascripts/bundle.cd18aaf1.min.js"></script>
 
 
  </body>

getting_started/index.html

@@ -481,7 +481,7 @@
 
 
  <li class="md-nav__item">
- <a href="../branch_planner/index.md" class="md-nav__link">
+ <a href="../branch_planner/" class="md-nav__link">
 
 
  <span class="md-ellipsis">

how_to/backup_and_restore_a_Terraform_state/index.html

@@ -344,7 +344,7 @@
 
 
  <li class="md-nav__item">
- <a href="../../branch_planner/index.md" class="md-nav__link">
+ <a href="../../branch_planner/" class="md-nav__link">
 
 
  <span class="md-ellipsis">

how_to/build-and-use-a-custom-runnner-image/index.html

@@ -344,7 +344,7 @@
 
 
  <li class="md-nav__item">
- <a href="../../branch_planner/index.md" class="md-nav__link">
+ <a href="../../branch_planner/" class="md-nav__link">
 
 
  <span class="md-ellipsis">

how_to/flux_receiver_and_alert/index.html

@@ -344,7 +344,7 @@
 
 
  <li class="md-nav__item">
- <a href="../../branch_planner/index.md" class="md-nav__link">
+ <a href="../../branch_planner/" class="md-nav__link">
 
 
  <span class="md-ellipsis">