2024-01-19: TR-477 Issue 1 Cloud CO Enhancement - Access Node Functio…

…nal Disaggregation

OD-360/04-deviation.md

@@ -1,4 +1,4 @@
-\## BBF Deviation Guidelines {.new-file}
+## BBF Deviation Guidelines {.new-file}
 
 It is understood that there are times in which a device will need to support a
 subset of a standard YANG model whether it be from BBF or any other SDO. YANG

check.sh

@@ -10,8 +10,6 @@
 
 cwd=`pwd`
 
-exp_dir="$cwd/experimental"
-
 # default arguments
 bbf_dir="$cwd/standard/bbf"
 ietf_dir="$cwd/standard/ietf"
@@ -47,7 +45,7 @@ ietf_dir=`pwd`
 
 cd $cwd
 
-pyang_flags="--max-line-length=70 --lint --lint-modulename-prefix=bbf --lint-namespace-prefix=urn:bbf:yang: --lint-ensure-hyphenated-name --verbose --path=$bbf_dir --path=$exp_dir --path=$ietf_dir --path=$ieee_dir"
+pyang_flags="--max-line-length=70 --lint --lint-modulename-prefix=bbf --lint-namespace-prefix=urn:bbf:yang: --lint-ensure-hyphenated-name --verbose --path=$bbf_dir --path=$ietf_dir --path=$ieee_dir"
 
 checkDir () {
     local dir="$bbf_dir/$1"

docs/extra.css

@@ -160,6 +160,26 @@ table.codethird td:nth-child(3)
     font-family: 'Courier New', Courier, 'Liberation Mono', monospace;
 }
 
+/* vertical-align top/middle/bottom table styles */
+
+table.vertical-align-top td, table.valign-top td {
+    vertical-align: top;
+}
+
+table.vertical-align-middle td, table.valign-middle td {
+    vertical-align: middle;
+}
+
+table.vertical-align-bottom td, table.valign-bottom td {
+    vertical-align: bottom;
+}
+
+/* figure overrides (github.css doesn't center captions) */
+
+figure {
+    text-align: center;
+}
+
 /* "left" and "right" styles */
 
 div.left {

docs/index.htm

@@ -298,6 +298,10 @@ <h1 class="title auto-hoverlink" id="title">OD-360 – Broadband Forum
 <li><a href="#sec:bbf-29-use-of-english-contractions"
 id="toc-sec:bbf-29-use-of-english-contractions">BBF-29: Use of English
 Contractions</a></li>
+</ul></li>
+<li><a href="#sec:bbf-deviation-guidelines"
+id="toc-sec:bbf-deviation-guidelines">BBF Deviation Guidelines</a>
+<ul>
 <li><a href="#sec:types-of-deviations"
 id="toc-sec:types-of-deviations">Types of Deviations</a></li>
 <li><a href="#sec:dev-1-not-supported"
@@ -485,31 +489,36 @@ <h1 class="title auto-hoverlink" id="title">OD-360 – Broadband Forum
 <div id="ref-RFC2119" class="csl-entry" role="listitem">
 <div class="csl-left-margin">[1] </div><div class="csl-right-inline">RFC
 2119, <em><a href="https://www.rfc-editor.org/rfc/rfc2119.html">Key
-words for use in RFCs to Indicate Requirement Levels</a></em>, IETF,
-1997</div>
+words for use in <span>RFCs</span> to <span>Indicate</span>
+<span>Requirement</span> <span>Levels</span></a></em>, IETF, 1997</div>
 </div>
 <div id="ref-RFC7223" class="csl-entry" role="listitem">
 <div class="csl-left-margin">[2] </div><div class="csl-right-inline">RFC
-7223, <em><a href="https://www.rfc-editor.org/rfc/rfc7223.html">A YANG
-Data Model for Interface Management</a></em>, IETF, 2014</div>
+7223, <em><a href="https://www.rfc-editor.org/rfc/rfc7223.html">A
+<span>YANG</span> <span>Data</span> <span>Model</span> for
+<span>Interface</span> <span>Management</span></a></em>, IETF,
+2014</div>
 </div>
 <div id="ref-RFC7950" class="csl-entry" role="listitem">
 <div class="csl-left-margin">[3] </div><div class="csl-right-inline">RFC
-7950, <em><a href="https://www.rfc-editor.org/rfc/rfc7950.html">The YANG
-1.1 Data Modeling Language</a></em>, IETF, 2016</div>
+7950, <em><a href="https://www.rfc-editor.org/rfc/rfc7950.html">The
+<span>YANG</span> 1.1 <span>Data</span> <span>Modeling</span>
+<span>Language</span></a></em>, IETF, 2016</div>
 </div>
 <div id="ref-RFC8174" class="csl-entry" role="listitem">
 <div class="csl-left-margin">[4] </div><div class="csl-right-inline">RFC
 8174, <em><a
 href="https://www.rfc-editor.org/rfc/rfc8174.html">Ambiguity of
-Uppercase vs Lowercase in RFC 2119 Key Words</a></em>, IETF, 2017</div>
+<span>Uppercase</span> vs <span>Lowercase</span> in <span>RFC</span>
+2119 <span>Key</span> <span>Words</span></a></em>, IETF, 2017</div>
 </div>
 <div id="ref-RFC8407" class="csl-entry" role="listitem">
 <div class="csl-left-margin">[5] </div><div class="csl-right-inline">RFC
 8407, <em><a
 href="https://www.rfc-editor.org/rfc/rfc8407.html">Guidelines for
-Authors and Reviewers of Documents Containing YANG Data Models</a></em>,
-IETF, 2018</div>
+<span>Authors</span> and <span>Reviewers</span> of
+<span>Documents</span> <span>Containing</span> <span>YANG</span>
+<span>Data</span> <span>Models</span></a></em>, IETF, 2018</div>
 </div>
 </div>
 <h1 class="auto-hoverlink" data-info="header"
@@ -1703,7 +1712,8 @@ <h4 class="auto-hoverlink" data-info="header" id="sec:draft">Draft</h4>
 <p>Descriptions in YANG modules are considered to be formal
 documentation. Therefore, English contractions, e.g., can’t, isn’t,
 etc., SHALL NOT be used in description statements.</p>
-<p>## BBF Deviation Guidelines {.new-file}</p>
+<h2 class="new-file auto-hoverlink" data-info="header"
+id="sec:bbf-deviation-guidelines">BBF Deviation Guidelines</h2>
 <p>It is understood that there are times in which a device will need to
 support a subset of a standard YANG model whether it be from BBF or any
 other SDO. YANG provides a means to explicitly model this subset of

docs/index.html

@@ -294,6 +294,7 @@ <h1 class="title auto-hoverlink" id="title">OD-360 – BBF YANG Best
 href="#sec:overview">Overview</a> | <a href="#sec:yang-guidelines">YANG
 Guidelines</a> | <a href="#sec:ietf-yang-guidelines">IETF YANG
 Guidelines</a> | <a href="#sec:bbf-yang-guidelines">BBF YANG
+Guidelines</a> | <a href="#sec:bbf-deviation-guidelines">BBF Deviation
 Guidelines</a> | <a href="#sec:bbf-guidelines-for-units-statements">BBF
 Guidelines for ‘units’ Statements</a></p>
     </nav>
@@ -420,6 +421,9 @@ <h2 id="toc-title">Table of Contents</h2>
 Description on ‘when’ statements</a></li>
 <li><a href="#sec:bbf-29-use-of-english-contractions">BBF-29: Use of
 English Contractions</a></li>
+</ul></li>
+<li><a href="#sec:bbf-deviation-guidelines">BBF Deviation Guidelines</a>
+<ul>
 <li><a href="#sec:types-of-deviations">Types of Deviations</a></li>
 <li><a href="#sec:dev-1-not-supported">DEV-1: not-supported</a></li>
 <li><a href="#sec:dev-2-add---number-of-elements">DEV-2: add - Number of
@@ -577,6 +581,9 @@ <h2 id="toc-title">Table of Contents</h2>
 Description on ‘when’ statements</a></li>
 <li><a href="#sec:bbf-29-use-of-english-contractions">BBF-29: Use of
 English Contractions</a></li>
+</ul></li>
+<li><a href="#sec:bbf-deviation-guidelines">BBF Deviation Guidelines</a>
+<ul>
 <li><a href="#sec:types-of-deviations">Types of Deviations</a></li>
 <li><a href="#sec:dev-1-not-supported">DEV-1: not-supported</a></li>
 <li><a href="#sec:dev-2-add---number-of-elements">DEV-2: add - Number of
@@ -756,31 +763,36 @@ <h1 class="auto-hoverlink" data-info="header">References</h1>
 <div id="ref-RFC2119" class="csl-entry" role="listitem">
 <div class="csl-left-margin">[1] </div><div class="csl-right-inline">RFC
 2119, <em><a href="https://www.rfc-editor.org/rfc/rfc2119.html">Key
-words for use in RFCs to Indicate Requirement Levels</a></em>, IETF,
-1997</div>
+words for use in <span>RFCs</span> to <span>Indicate</span>
+<span>Requirement</span> <span>Levels</span></a></em>, IETF, 1997</div>
 </div>
 <div id="ref-RFC7223" class="csl-entry" role="listitem">
 <div class="csl-left-margin">[2] </div><div class="csl-right-inline">RFC
-7223, <em><a href="https://www.rfc-editor.org/rfc/rfc7223.html">A YANG
-Data Model for Interface Management</a></em>, IETF, 2014</div>
+7223, <em><a href="https://www.rfc-editor.org/rfc/rfc7223.html">A
+<span>YANG</span> <span>Data</span> <span>Model</span> for
+<span>Interface</span> <span>Management</span></a></em>, IETF,
+2014</div>
 </div>
 <div id="ref-RFC7950" class="csl-entry" role="listitem">
 <div class="csl-left-margin">[3] </div><div class="csl-right-inline">RFC
-7950, <em><a href="https://www.rfc-editor.org/rfc/rfc7950.html">The YANG
-1.1 Data Modeling Language</a></em>, IETF, 2016</div>
+7950, <em><a href="https://www.rfc-editor.org/rfc/rfc7950.html">The
+<span>YANG</span> 1.1 <span>Data</span> <span>Modeling</span>
+<span>Language</span></a></em>, IETF, 2016</div>
 </div>
 <div id="ref-RFC8174" class="csl-entry" role="listitem">
 <div class="csl-left-margin">[4] </div><div class="csl-right-inline">RFC
 8174, <em><a
 href="https://www.rfc-editor.org/rfc/rfc8174.html">Ambiguity of
-Uppercase vs Lowercase in RFC 2119 Key Words</a></em>, IETF, 2017</div>
+<span>Uppercase</span> vs <span>Lowercase</span> in <span>RFC</span>
+2119 <span>Key</span> <span>Words</span></a></em>, IETF, 2017</div>
 </div>
 <div id="ref-RFC8407" class="csl-entry" role="listitem">
 <div class="csl-left-margin">[5] </div><div class="csl-right-inline">RFC
 8407, <em><a
 href="https://www.rfc-editor.org/rfc/rfc8407.html">Guidelines for
-Authors and Reviewers of Documents Containing YANG Data Models</a></em>,
-IETF, 2018</div>
+<span>Authors</span> and <span>Reviewers</span> of
+<span>Documents</span> <span>Containing</span> <span>YANG</span>
+<span>Data</span> <span>Models</span></a></em>, IETF, 2018</div>
 </div>
 </div>
 </section>
@@ -1350,17 +1362,6 @@ <h2 class="auto-hoverlink" data-info="header">BBF YANG Guidelines</h2>
 Description on ‘when’ statements</a></li>
 <li><a href="#sec:bbf-29-use-of-english-contractions">BBF-29: Use of
 English Contractions</a></li>
-<li><a href="#sec:types-of-deviations">Types of Deviations</a></li>
-<li><a href="#sec:dev-1-not-supported">DEV-1: not-supported</a></li>
-<li><a href="#sec:dev-2-add---number-of-elements">DEV-2: add - Number of
-Elements</a></li>
-<li><a href="#sec:dev-3-add---must-constraints">DEV-3: add - ‘must’
-Constraints</a></li>
-<li><a href="#sec:dev-4-replace---data-type">DEV-4: replace - Data
-Type</a></li>
-<li><a href="#sec:dev-5-replace---number-of-elements">DEV-5: replace -
-Number of Elements</a></li>
-<li><a href="#sec:dev-6-delete">DEV-6: delete</a></li>
 </ul>
 <p>This section adds BBF-specific guidelines that go beyond the scope of
 the IETF YANG Guidelines.</p>
@@ -2109,7 +2110,24 @@ <h4 class="auto-hoverlink" data-info="header" id="sec:draft">Draft</h4>
 <p>Descriptions in YANG modules are considered to be formal
 documentation. Therefore, English contractions, e.g., can’t, isn’t,
 etc., SHALL NOT be used in description statements.</p>
-<p>## BBF Deviation Guidelines {.new-file}</p>
+</section>
+<section id="sec:bbf-deviation-guidelines"
+class="auto-hoverlink new-section hidden" data-info="header">
+<h2 class="auto-hoverlink" data-info="header">BBF Deviation
+Guidelines</h2>
+<ul>
+<li><a href="#sec:types-of-deviations">Types of Deviations</a></li>
+<li><a href="#sec:dev-1-not-supported">DEV-1: not-supported</a></li>
+<li><a href="#sec:dev-2-add---number-of-elements">DEV-2: add - Number of
+Elements</a></li>
+<li><a href="#sec:dev-3-add---must-constraints">DEV-3: add - ‘must’
+Constraints</a></li>
+<li><a href="#sec:dev-4-replace---data-type">DEV-4: replace - Data
+Type</a></li>
+<li><a href="#sec:dev-5-replace---number-of-elements">DEV-5: replace -
+Number of Elements</a></li>
+<li><a href="#sec:dev-6-delete">DEV-6: delete</a></li>
+</ul>
 <p>It is understood that there are times in which a device will need to
 support a subset of a standard YANG model whether it be from BBF or any
 other SDO. YANG provides a means to explicitly model this subset of
@@ -2481,6 +2499,7 @@ <h2 class="auto-hoverlink" data-info="header">BBF Guidelines for ‘units’
 href="#sec:overview">Overview</a> | <a href="#sec:yang-guidelines">YANG
 Guidelines</a> | <a href="#sec:ietf-yang-guidelines">IETF YANG
 Guidelines</a> | <a href="#sec:bbf-yang-guidelines">BBF YANG
+Guidelines</a> | <a href="#sec:bbf-deviation-guidelines">BBF Deviation
 Guidelines</a> | <a href="#sec:bbf-guidelines-for-units-statements">BBF
 Guidelines for ‘units’ Statements</a></p>
     </nav>

docs/index.md

@@ -1047,7 +1047,7 @@ when "not(boolean(../enable))"
 Descriptions in YANG modules are considered to be formal documentation. Therefore, English contractions, e.g., can't, isn't, etc., SHALL NOT be used in description statements.
 
 
-\## BBF Deviation Guidelines {.new-file}
+## BBF Deviation Guidelines {.new-file}
 
 It is understood that there are times in which a device will need to support a
 subset of a standard YANG model whether it be from BBF or any other SDO. YANG

docs/index.typ

@@ -283,32 +283,33 @@ directed to
 #bbf-csl-entry[
 #bbf-csl-left-margin[[1] ]#bbf-csl-right-inline[RFC 2119,
 _#link("https://www.rfc-editor.org/rfc/rfc2119.html")[Key words for use
-in RFCs to Indicate Requirement Levels]_, IETF, 1997]
+in #[RFCs] to #[Indicate] #[Requirement] #[Levels]]_, IETF, 1997]
 ] <ref-RFC2119>
 
 #bbf-csl-entry[
 #bbf-csl-left-margin[[2] ]#bbf-csl-right-inline[RFC 7223,
-_#link("https://www.rfc-editor.org/rfc/rfc7223.html")[A YANG Data Model
-for Interface Management]_, IETF, 2014]
+_#link("https://www.rfc-editor.org/rfc/rfc7223.html")[A #[YANG] #[Data]
+#[Model] for #[Interface] #[Management]]_, IETF, 2014]
 ] <ref-RFC7223>
 
 #bbf-csl-entry[
 #bbf-csl-left-margin[[3] ]#bbf-csl-right-inline[RFC 7950,
-_#link("https://www.rfc-editor.org/rfc/rfc7950.html")[The YANG 1.1 Data
-Modeling Language]_, IETF, 2016]
+_#link("https://www.rfc-editor.org/rfc/rfc7950.html")[The #[YANG] 1.1
+#[Data] #[Modeling] #[Language]]_, IETF, 2016]
 ] <ref-RFC7950>
 
 #bbf-csl-entry[
 #bbf-csl-left-margin[[4] ]#bbf-csl-right-inline[RFC 8174,
 _#link("https://www.rfc-editor.org/rfc/rfc8174.html")[Ambiguity of
-Uppercase vs Lowercase in RFC 2119 Key Words]_, IETF, 2017]
+#[Uppercase] vs #[Lowercase] in #[RFC] 2119 #[Key] #[Words]]_, IETF,
+2017]
 ] <ref-RFC8174>
 
 #bbf-csl-entry[
 #bbf-csl-left-margin[[5] ]#bbf-csl-right-inline[RFC 8407,
 _#link("https://www.rfc-editor.org/rfc/rfc8407.html")[Guidelines for
-Authors and Reviewers of Documents Containing YANG Data Models]_, IETF,
-2018]
+#[Authors] and #[Reviewers] of #[Documents] #[Containing] #[YANG]
+#[Data] #[Models]]_, IETF, 2018]
 ] <ref-RFC8407>
 ] <refs>]
 
@@ -1680,7 +1681,8 @@ Descriptions in YANG modules are considered to be formal documentation.
 Therefore, English contractions, e.g., can’t, isn’t, etc., SHALL NOT be
 used in description statements.
 
-\#\# BBF Deviation Guidelines {.new\-file}
+#bbf-new-file[
+== BBF Deviation Guidelines <sec:bbf-deviation-guidelines>]
 
 It is understood that there are times in which a device will need to
 support a subset of a standard YANG model whether it be from BBF or any

docs/json-defaults.yaml

@@ -47,17 +47,8 @@ filters:
 # metadata values specified here are parsed as literal strings, not markdown
 metadata:
 
-  # if there are duplicates, the latest occurrence wins, so more definitive
-  # definitions are listed last
   bibliography:
-    - tr-069-biblio-csl.json
-    - 3gpp-biblio-csl.json
-    - ansi-biblio-csl.json
-    - ieee-biblio-csl.json
-    - iso-biblio-csl.json
-    - itu-biblio-csl.json
-    - w3c-biblio-csl.json
-    - ietf-biblio-csl.json
+    - all.bib
     - bbf-biblio-csl.json
 
   citation-style: bbf.csl