Merge pull request TheThingsIndustries#339 from TheThingsIndustries/doc/pb-wiring

benolayinka · web-flow · commit 4c4925eb59c9 · 2021-05-06T13:56:52.000+03:00
Document Packet Broker regional cluster config
diff --git a/doc/content/reference/packet-broker/_index.md b/doc/content/reference/packet-broker/_index.md
@@ -58,11 +58,15 @@ Localization | O | | Gateway locations, timestamps and signal quality
 
 ## Getting Started
 
-{{% tts %}} Community Edition or {{% tts %}} Cloud {{< distributions "Cloud" "Dedicated Cloud" "Community" >}} is already connected to Packet Broker. Proceed to [Configure]({{< relref "configure" >}}) section to manage your registration and routing policies with other networks.
+{{% tts %}} Community Edition and {{% tts %}} Cloud are already connected to Packet Broker. Proceed to [Configure]({{< relref "configure" >}}) section to manage your registration and routing policies with other networks.
 
-When you are using {{% tts %}} Community Edition {{< distributions "Community" >}}, you cannot configure any routing policies, as {{% tts %}} Community Edition is a public network and The Things Network Foundation controls which public or private networks the traffic gets exchanged with. To manage routing policies for your gateways, upgrade to {{% tts %}} Cloud.
+{{< note >}}
+{{% tts %}} Community Edition and {{% tts %}} Cloud are configured for peering within the same geographical region. For example, {{% tts %}} Community Edition `eu1` cluster is configured to peer only with {{% tts %}} Cloud `eu1` deployments and vice versa. Peering between `eu1`, `au1` and `nam1` clusters is not currently enabled.
+{{</ note >}}
 
-When using {{% tts %}} Enterprise of {{% tts %}} Open Source, learn to [Connect {{% tts %}} to Packet Broker]({{< relref "connect" >}}). {{< distributions "Enterprise" "Open Source" >}}
+When you are using {{% tts %}} Community Edition, you cannot configure any routing policies, as {{% tts %}} Community Edition is a public network and The Things Network Foundation controls which public or private networks the traffic gets exchanged with. To manage routing policies for your gateways, upgrade to {{% tts %}} Cloud.
+
+When using {{% tts %}} Enterprise of {{% tts %}} Open Source, learn to [Connect {{% tts %}} to Packet Broker]({{< relref "connect" >}}).
 
 ## LoRaWAN Roaming vs Packet Broker
 
diff --git a/doc/content/reference/packet-broker/connect.md b/doc/content/reference/packet-broker/connect.md
@@ -19,10 +19,11 @@ If you are using {{% tts %}} Cloud or if your {{% tts %}} deployment is connecte
 
 ## Prerequisites
 
-1. A LoRa Alliance NetID or a tenant of a host NetID.
-  - To obtain a NetID, [become a member of the LoRa Alliance](https://lora-alliance.org/become-a-member) (from USD 6,000 per year)
-  - To obtain a DevAddr block, [contact The Things Industries sales](mailto:sales@thethingsindustries.com) (from USD 1,000 per year)
-2. Access to Packet Broker with an API key, [contact The Things Industries sales](mailto:sales@thethingsindustries.com)
+1. A LoRa Alliance NetID or a tenant of a host NetID
+  - To obtain a NetID, [become a member of the LoRa Alliance](https://lora-alliance.org/become-a-member)
+  - To obtain a DevAddr block, [contact The Things Industries sales](mailto:sales@thethingsindustries.com)
+2. Access to Packet Broker with an API key
+  - To obtain access to Packet Broker, [contact The Things Industries sales](mailto:sales@thethingsindustries.com)
 3. {{% tts %}} installed and configured. See [Getting Started]({{< ref "/getting-started" >}})
 4. Packet Broker CLI installed and configured. See [Packet Broker CLI](https://github.com/packetbroker/pb)
 
@@ -66,7 +67,7 @@ See [Packet Broker Agent configuration]({{< ref "/reference/configuration/packet
 
 ## Configure Gateway Server
 
-Configure Gateway Server to forward traffic for the current network to the Network Server in the cluster, and route all traffic to Packet Broker (via Packet Broker Agent):
+Configure the Gateway Server to forward traffic for the current network to the Network Server in the cluster, and route all traffic to Packet Broker (via Packet Broker Agent):
 
 ```yaml
 # Edit the Gateway Server configuration in your configuration file:
@@ -84,7 +85,7 @@ See [Gateway Server configuration]({{< ref "/reference/configuration/gateway-ser
 
 ## Configure Network Server
 
-Configure Network Server to issue device addresses (DevAddr) that fall within your NetID:
+Configure the Network Server to issue device addresses (DevAddr) that fall within your NetID:
 
 ```yaml
 # Edit the Network Server configuration in your configuration file:
@@ -105,7 +106,7 @@ ns:
   - '27222200/16'
 ```
 
-{{< note >}} By default, Network Server uses NetID `000000` which is intended for experimentation purposes. Only devices that are activated with a DevAddr that refers to a NetID will have their traffic routed by Packet Broker to your network. {{</ note >}}
+{{< note >}} By default, the Network Server uses NetID `000000` which is intended for experimentation purposes. Only devices that are activated with a DevAddr that refers to a NetID will have their traffic routed by Packet Broker to your network. {{</ note >}}
 
 See [Network Server configuration]({{< ref "/reference/configuration/network-server" >}}) for all configuration options.
 
diff --git a/doc/data/distributions.yml b/doc/data/distributions.yml
@@ -1,18 +1,30 @@
 Cloud:
+  name: "Cloud"
   color: "#0032B4"
   icon: "/img/tts_frames/frame_cloud.svg"
+  weight: 1
 Dedicated Cloud:
+  name: "Dedicated Cloud"
   color: "#D356FF"
   icon: "/img/tts_frames/frame_dedicated_cloud.svg"
+  weight: 2
 Community:
+  name: "Community"
   color: "#0D83D0"
   icon: "/img/tts_frames/frame_ttn.svg"
+  weight: 9
 Open Source:
+  name: "Open Source"
   color: "#00C1FF"
   icon: "/img/tts_frames/frame_open_source.svg"
+  weight: 5
 Enterprise:
+  name: "Enterprise"
   color: "#00C985"
   icon: "/img/tts_frames/frame_enterprise.svg"
+  weight: 3
 AWS Launcher:
+  name: "AWS Launcher"
   color: "#F19419"
   icon: "/img/tts_frames/frame_aws.svg"
+  weight: 4
diff --git a/doc/layouts/partials/distribution-icons.html b/doc/layouts/partials/distribution-icons.html
@@ -1,6 +1,9 @@
-<a href="{{ "download" | relURL }}" target="_blank" class="badge-stack has-tooltip has-tooltip-arrow has-tooltip-light" data-tooltip="{{ delimit . ", " " and " }} Only">
-  {{ range . }}
-    {{ $distribution := index site.Data.distributions . }}
-    <img class="badge" src="{{ index $distribution "icon" | relURL }}"></img>
-  {{ end }}
+{{ $distribution_strings := slice }}
+{{ range sort . "weight" "asc" }}
+  {{ $distribution_strings = append .name $distribution_strings }}
+{{ end }}
+<a href="{{ "download" | relURL }}" target="_blank" class="badge-stack has-tooltip has-tooltip-arrow has-tooltip-light" data-tooltip="{{ delimit $distribution_strings ", " " and " }} Only">
+{{ range sort . "weight" "asc" }}
+  <img class="badge" src="{{ .icon | relURL }}"></img>
+{{ end }}
 </a>
diff --git a/doc/layouts/partials/distributions.html b/doc/layouts/partials/distributions.html
@@ -2,11 +2,14 @@
 {{ if ( not ( reflect.IsSlice $distributions_sliced ) ) }}
   {{ $distributions_sliced = slice $distributions_sliced }}
 {{ end }}
-{{ $distributions :=  sort $distributions_sliced }}
 {{ $distributions_all := index site.Data "distributions" }}
-{{ range $distributions }}
+{{ $test := where ( index site.Data "distributions" ) "name" "in" "$distributions" }}
+{{ $distributions_sliced_map := dict }}
+{{ range $distributions_sliced }}
   {{ if not (isset $distributions_all .) }}
     {{ errorf "distribution '%s' not in '%s'" . (delimit $distributions_all ", ") }}
+  {{ else }}
+    {{ $distributions_sliced_map = merge $distributions_sliced_map (dict . (index $distributions_all . ) ) }}
   {{ end }}
 {{ end }}
-{{ partial "distribution-icons" $distributions}}
+{{ partial "distribution-icons" $distributions_sliced_map }}
diff --git a/doc/layouts/shortcodes/distributions-inline.html b/doc/layouts/shortcodes/distributions-inline.html
diff --git a/doc/layouts/shortcodes/distributions-list.html b/doc/layouts/shortcodes/distributions-list.html
