This is an automated email from the ASF dual-hosted git repository.
ocket8888 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficcontrol.git
The following commit(s) were added to refs/heads/master by this push:
new f8754c3da9 Correct docs for topologies incorrectly specifying a upper
limit on parents and children (#7729)
f8754c3da9 is described below
commit f8754c3da974ba6860c087e06f8824c2f4c21acd
Author: Mohit-Attree <[email protected]>
AuthorDate: Mon Aug 21 23:27:09 2023 +0530
Correct docs for topologies incorrectly specifying a upper limit on parents
and children (#7729)
* Update glossary.rst
* correct docs/topologies v3,v4,v5
* Revert "correct docs/topologies v3,v4,v5"
This reverts commit 6d0d652e2e5f0ff761958809c2f5744114d8dd03.
* Correct documentation around topologies(apache#7617)
* Correct the glossary -topologies can have as many parents and
children.
* remove the 2-parents max from docs of api v3,v4,v5
---------
Co-authored-by: Mohit Sharma <[email protected]>
---
docs/source/api/v3/topologies.rst | 10 +++++-----
docs/source/api/v4/topologies.rst | 10 +++++-----
docs/source/api/v5/topologies.rst | 10 +++++-----
docs/source/glossary.rst | 2 +-
4 files changed, 16 insertions(+), 16 deletions(-)
diff --git a/docs/source/api/v3/topologies.rst
b/docs/source/api/v3/topologies.rst
index 0b848810ea..1d21471420 100644
--- a/docs/source/api/v3/topologies.rst
+++ b/docs/source/api/v3/topologies.rst
@@ -55,7 +55,7 @@ Response Structure
:nodes: An array of nodes in the :term:`Topology`
:cachegroup: The name of a :term:`Cache Group`
- :parents: The indices of the parents of this node in the
nodes array, 0-indexed. 2 parents max
+ :parents: The indices of the parents of this node in the
nodes array, 0-indexed.
.. code-block:: http
:caption: Response Example
@@ -161,7 +161,7 @@ Request Structure
:nodes: An array of nodes in the :term:`Topology`
:cachegroup: The name of a :term:`Cache Group` with at least
1 server in it
- :parents: The indices of the parents of this node in the
nodes array, 0-indexed. 2 parents max
+ :parents: The indices of the parents of this node in the
nodes array, 0-indexed.
.. code-block:: http
:caption: Request Example
@@ -251,7 +251,7 @@ Response Structure
:nodes: An array of nodes in the :term:`Topology`
:cachegroup: The name of a :term:`Cache Group`
- :parents: The indices of the parents of this node in the
nodes array, 0-indexed. 2 parents max
+ :parents: The indices of the parents of this node in the
nodes array, 0-indexed.
.. code-block:: http
:caption: Response Example
@@ -369,7 +369,7 @@ Request Structure
:nodes: An array of nodes in the :term:`Topology`
:cachegroup: The name of a :term:`Cache Group` with at least
1 server in it
- :parents: The indices of the parents of this node in the
nodes array, 0-indexed. 2 parents max
+ :parents: The indices of the parents of this node in the
nodes array, 0-indexed.
.. code-block:: http
:caption: Request Example
@@ -451,7 +451,7 @@ Response Structure
:nodes: An array of nodes in the :term:`Topology`
:cachegroup: The name of a :term:`Cache Group`
- :parents: The indices of the parents of this node in the
nodes array, 0-indexed. 2 parents max
+ :parents: The indices of the parents of this node in the
nodes array, 0-indexed.
.. code-block:: http
:caption: Response Example
diff --git a/docs/source/api/v4/topologies.rst
b/docs/source/api/v4/topologies.rst
index b28cdedcab..2eaf1077a6 100644
--- a/docs/source/api/v4/topologies.rst
+++ b/docs/source/api/v4/topologies.rst
@@ -56,7 +56,7 @@ Response Structure
:nodes: An array of nodes in the :term:`Topology`
:cachegroup: The name of a :term:`Cache Group`
- :parents: The indices of the parents of this node in the
nodes array, 0-indexed. 2 parents max
+ :parents: The indices of the parents of this node in the
nodes array, 0-indexed.
.. code-block:: http
:caption: Response Example
@@ -163,7 +163,7 @@ Request Structure
:nodes: An array of nodes in the :term:`Topology`
:cachegroup: The name of a :term:`Cache Group` with at least
1 server in it
- :parents: The indices of the parents of this node in the
nodes array, 0-indexed. 2 parents max
+ :parents: The indices of the parents of this node in the
nodes array, 0-indexed.
.. code-block:: http
:caption: Request Example
@@ -253,7 +253,7 @@ Response Structure
:nodes: An array of nodes in the :term:`Topology`
:cachegroup: The name of a :term:`Cache Group`
- :parents: The indices of the parents of this node in the
nodes array, 0-indexed. 2 parents max
+ :parents: The indices of the parents of this node in the
nodes array, 0-indexed.
.. code-block:: http
:caption: Response Example
@@ -372,7 +372,7 @@ Request Structure
:nodes: An array of nodes in the :term:`Topology`
:cachegroup: The name of a :term:`Cache Group` with at least
1 server in it
- :parents: The indices of the parents of this node in the
nodes array, 0-indexed. 2 parents max
+ :parents: The indices of the parents of this node in the
nodes array, 0-indexed.
.. code-block:: http
:caption: Request Example
@@ -454,7 +454,7 @@ Response Structure
:nodes: An array of nodes in the :term:`Topology`
:cachegroup: The name of a :term:`Cache Group`
- :parents: The indices of the parents of this node in the
nodes array, 0-indexed. 2 parents max
+ :parents: The indices of the parents of this node in the
nodes array, 0-indexed.
.. code-block:: http
:caption: Response Example
diff --git a/docs/source/api/v5/topologies.rst
b/docs/source/api/v5/topologies.rst
index 8118424999..c39128b8aa 100644
--- a/docs/source/api/v5/topologies.rst
+++ b/docs/source/api/v5/topologies.rst
@@ -56,7 +56,7 @@ Response Structure
:nodes: An array of nodes in the :term:`Topology`
:cachegroup: The name of a :term:`Cache Group`
- :parents: The indices of the parents of this node in the
nodes array, 0-indexed. 2 parents max
+ :parents: The indices of the parents of this node in the
nodes array, 0-indexed.
.. code-block:: http
:caption: Response Example
@@ -163,7 +163,7 @@ Request Structure
:nodes: An array of nodes in the :term:`Topology`
:cachegroup: The name of a :term:`Cache Group` with at least
1 server in it
- :parents: The indices of the parents of this node in the
nodes array, 0-indexed. 2 parents max
+ :parents: The indices of the parents of this node in the
nodes array, 0-indexed.
.. code-block:: http
:caption: Request Example
@@ -253,7 +253,7 @@ Response Structure
:nodes: An array of nodes in the :term:`Topology`
:cachegroup: The name of a :term:`Cache Group`
- :parents: The indices of the parents of this node in the
nodes array, 0-indexed. 2 parents max
+ :parents: The indices of the parents of this node in the
nodes array, 0-indexed.
.. code-block:: http
:caption: Response Example
@@ -372,7 +372,7 @@ Request Structure
:nodes: An array of nodes in the :term:`Topology`
:cachegroup: The name of a :term:`Cache Group` with at least
1 server in it
- :parents: The indices of the parents of this node in the
nodes array, 0-indexed. 2 parents max
+ :parents: The indices of the parents of this node in the
nodes array, 0-indexed.
.. code-block:: http
:caption: Request Example
@@ -454,7 +454,7 @@ Response Structure
:nodes: An array of nodes in the :term:`Topology`
:cachegroup: The name of a :term:`Cache Group`
- :parents: The indices of the parents of this node in the
nodes array, 0-indexed. 2 parents max
+ :parents: The indices of the parents of this node in the
nodes array, 0-indexed.
.. code-block:: http
:caption: Response Example
diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst
index 3d0607c6e2..98fcc8c351 100644
--- a/docs/source/glossary.rst
+++ b/docs/source/glossary.rst
@@ -457,7 +457,7 @@ Glossary
Parent Topology Nodes
Child Topology Node
Child Topology Nodes
- Each :dfn:`Topology Node` is associated with a particular
:term:`Cache Group`. In addition, the Topology Node has 0, 1, or 2 Parent
Topology Nodes and has 0, 1, or 2 Child Topology Nodes, according to your
configuration.
+ Each :dfn:`Topology Node` is associated with a particular
:term:`Cache Group`. In addition, there is no limit on the maximum number of
parents and children for any given Topology Node, according to your
configuration.
Topology
Topologies
