Skip to content

Commit 5b13eaf

Browse files
bradh352bradh352
authored
YANG Configuration.md fix table of contents links (#21072)
Why I did it Due to excess whitespace, the table of contents does not render as links in github, leading to navigation issues. This might cause some minor "pain" for other merge requests due to the formatting differences in the ToC, but it should really only take a second to correct. Better to fix it once and make everyone's life easier than just living with it. Work item tracking How I did it Updated whitespace and a couple other very minor correctness changes for MarkDown. There are still other changes I'd like to do but much lower priority and possibly not worth the disturbance. How to verify it View the corrected table of contents here: https://github.com/bradh352/sonic-buildimage/blob/configuration.md/src/sonic-yang-models/doc/Configuration.md Compared to original unrendered ToC here: https://github.com/sonic-net/sonic-buildimage/blob/master/src/sonic-yang-models/doc/Configuration.md Which release branch to backport (provide reason below if selected) Not needed Tested branch (Please provide the tested image version) master as of 20241206 Description for the changelog YANG Configuration.md fix table of contents links
1 parent 33dc795 commit 5b13eaf

File tree

1 file changed

+96
-105
lines changed

1 file changed

+96
-105
lines changed

‎src/sonic-yang-models/doc/Configuration.md‎

Lines changed: 96 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -1,103 +1,98 @@
1-
=======
21
# SONiC Configuration Database Manual
32

4-
Table of Contents
5-
=================
6-
7-
* [Introduction](#introduction)
8-
* [Configuration](#configuration)
9-
* [<strong>Config Load and Save</strong>](#config-load-and-save)
10-
11-
* [Incremental Configuration](#incremental-configuration)
12-
* [<strong>Redis and Json Schema</strong>](#redis-and-json-schema)
13-
14-
* [ACL and Mirroring](#acl-and-mirroring)
15-
* [BGP BBR](#bgp-bbr)
16-
* [ASIC SDK health event](#asic-sdk-health-event)
17-
* [BGP Device Global](#bgp-device-global)
18-
* [BGP Sessions](#bgp-sessions)
19-
* [BUFFER_PG](#buffer_pg)
20-
* [Buffer pool](#buffer-pool)
21-
* [Buffer profile](#buffer-profile)
22-
* [Buffer queue](#buffer-queue)
23-
* [Buffer port ingress profile list](#buffer-port-ingress-profile-list)
24-
* [Buffer port egress profile list](#buffer-port-egress-profile-list)
25-
* [Cable length](#cable-length)
26-
* [Chassis module](#chassis-module)
27-
* [COPP_TABLE](#copp_table)
28-
* [Console](#console)
29-
* [CRM](#crm)
30-
* [CRM DASH](#crm-dash)
31-
* [Data Plane L3 Interfaces](#data-plane-l3-interfaces)
32-
* [DEFAULT_LOSSLESS_BUFFER_PARAMETER](#DEFAULT_LOSSLESS_BUFFER_PARAMETER)
33-
* [Device Metadata](#device-metadata)
34-
* [Device neighbor metada](#device-neighbor-metada)
35-
* [DHCP_RELAY](#dhcp_relay)
36-
* [DHCP Server IPV4](#dhcp_server_ipv4)
37-
* [BMP](#bmp)
38-
* [DSCP_TO_TC_MAP](#dscp_to_tc_map)
39-
* [FG_NHG](#fg_nhg)
40-
* [FG_NHG_MEMBER](#fg_nhg_member)
41-
* [FG_NHG_PREFIX](#fg_nhg_prefix)
42-
* [FABRIC_MONITOR](#fabric-monitor)
43-
* [FABRIC_PORT](#fabric-port)
44-
* [FLEX_COUNTER_TABLE](#flex_counter_table)
45-
* [GRPCCLIENT](#grpcclient)
46-
* [Hash](#hash)
47-
* [IPv6 Link-local] (#ipv6-link-local)
48-
* [KDUMP](#kdump)
49-
* [Kubernetes Master](#kubernetes-master)
50-
* [L2 Neighbors](#l2-neighbors)
51-
* [Loopback Interface](#loopback-interface)
52-
* [LOSSLESS_TRAFFIC_PATTERN](#LOSSLESS_TRAFFIC_PATTERN)
53-
* [Memory Statistics](#memory-statistics)
54-
* [Management Interface](#management-interface)
55-
* [Management port](#management-port)
56-
* [Management VRF](#management-vrf)
57-
* [MAP_PFC_PRIORITY_TO_QUEUE](#map_pfc_priority_to_queue)
58-
* [MUX_CABLE](#mux_cable)
59-
* [MUX_LINKMGR](#mux_linkmgr)
60-
* [NEIGH](#neigh)
61-
* [NTP Global Configuration](#ntp-global-configuration)
62-
* [NTP Servers](#ntp-servers)
63-
* [Peer Switch](#peer-switch)
64-
* [Policer](#policer)
65-
* [Port](#port)
66-
* [Port Channel](#port-channel)
67-
* [Portchannel member](#portchannel-member)
68-
* [Scheduler](#scheduler)
69-
* [Port QoS Map](#port-qos-map)
70-
* [Queue](#queue)
71-
* [Syslog Global Configuration](#syslog-global-configuration)
72-
* [Syslog Servers](#syslog-servers)
73-
* [Sflow](#sflow)
74-
* [Restapi](#restapi)
75-
* [System Port](#system-port)
76-
* [Tacplus Server](#tacplus-server)
77-
* [TC to Priority group map](#tc-to-priority-group-map)
78-
* [TC to Queue map](#tc-to-queue-map)
79-
* [Telemetry](#telemetry)
80-
* [Telemetry client](#telemetry-client)
81-
* [Tunnel](#tunnel)
82-
* [Versions](#versions)
83-
* [VLAN](#vlan)
84-
* [VLAN_MEMBER](#vlan_member)
85-
* [VNET](#vnet)
86-
* [VOQ Inband Interface](#voq-inband-interface)
87-
* [VXLAN](#vxlan)
88-
* [Virtual router](#virtual-router)
89-
* [LOGGER](#logger)
90-
* [WRED_PROFILE](#wred_profile)
91-
* [XCVRD_LOG](#xcvrd_log)
92-
* [PASSWORD_HARDENING](#password_hardening)
93-
* [SSH_SERVER](#ssh_server)
94-
* [SYSTEM_DEFAULTS table](#systemdefaults-table)
95-
* [RADIUS](#radius)
96-
* [Static DNS](#static-dns)
97-
* [For Developers](#for-developers)
98-
* [Generating Application Config by Jinja2 Template](#generating-application-config-by-jinja2-template)
99-
* [Incremental Configuration by Subscribing to ConfigDB](#incremental-configuration-by-subscribing-to-configdb)
100-
3+
**Table of Contents**
4+
5+
* [Introduction](#introduction)
6+
* [Configuration](#configuration)
7+
* [<strong>Config Load and Save</strong>](#config-load-and-save)
8+
* [Incremental Configuration](#incremental-configuration)
9+
* [<strong>Redis and Json Schema</strong>](#redis-and-json-schema)
10+
* [ACL and Mirroring](#acl-and-mirroring)
11+
* [BGP BBR](#bgp-bbr)
12+
* [ASIC SDK health event](#asic-sdk-health-event)
13+
* [BGP Device Global](#bgp-device-global)
14+
* [BGP Sessions](#bgp-sessions)
15+
* [BUFFER_PG](#buffer_pg)
16+
* [Buffer pool](#buffer-pool)
17+
* [Buffer profile](#buffer-profile)
18+
* [Buffer queue](#buffer-queue)
19+
* [Buffer port ingress profile list](#buffer-port-ingress-profile-list)
20+
* [Buffer port egress profile list](#buffer-port-egress-profile-list)
21+
* [Cable length](#cable-length)
22+
* [Chassis module](#chassis-module)
23+
* [COPP_TABLE](#copp_table)
24+
* [Console](#console)
25+
* [CRM](#crm)
26+
* [CRM DASH](#crm-dash)
27+
* [Data Plane L3 Interfaces](#data-plane-l3-interfaces)
28+
* [DEFAULT_LOSSLESS_BUFFER_PARAMETER](#DEFAULT_LOSSLESS_BUFFER_PARAMETER)
29+
* [Device Metadata](#device-metadata)
30+
* [Device neighbor metada](#device-neighbor-metada)
31+
* [DHCP_RELAY](#dhcp_relay)
32+
* [DHCP Server IPV4](#dhcp_server_ipv4)
33+
* [BMP](#bmp)
34+
* [DSCP_TO_TC_MAP](#dscp_to_tc_map)
35+
* [FG_NHG](#fg_nhg)
36+
* [FG_NHG_MEMBER](#fg_nhg_member)
37+
* [FG_NHG_PREFIX](#fg_nhg_prefix)
38+
* [FABRIC_MONITOR](#fabric-monitor)
39+
* [FABRIC_PORT](#fabric-port)
40+
* [FLEX_COUNTER_TABLE](#flex_counter_table)
41+
* [GRPCCLIENT](#grpcclient)
42+
* [Hash](#hash)
43+
* [IPv6 Link-local] (#ipv6-link-local)
44+
* [KDUMP](#kdump)
45+
* [Kubernetes Master](#kubernetes-master)
46+
* [L2 Neighbors](#l2-neighbors)
47+
* [Loopback Interface](#loopback-interface)
48+
* [LOSSLESS_TRAFFIC_PATTERN](#LOSSLESS_TRAFFIC_PATTERN)
49+
* [Memory Statistics](#memory-statistics)
50+
* [Management Interface](#management-interface)
51+
* [Management port](#management-port)
52+
* [Management VRF](#management-vrf)
53+
* [MAP_PFC_PRIORITY_TO_QUEUE](#map_pfc_priority_to_queue)
54+
* [MUX_CABLE](#mux_cable)
55+
* [MUX_LINKMGR](#mux_linkmgr)
56+
* [NEIGH](#neigh)
57+
* [NTP Global Configuration](#ntp-global-configuration)
58+
* [NTP Servers](#ntp-servers)
59+
* [Peer Switch](#peer-switch)
60+
* [Policer](#policer)
61+
* [Port](#port)
62+
* [Port Channel](#port-channel)
63+
* [Portchannel member](#portchannel-member)
64+
* [Scheduler](#scheduler)
65+
* [Port QoS Map](#port-qos-map)
66+
* [Queue](#queue)
67+
* [Syslog Global Configuration](#syslog-global-configuration)
68+
* [Syslog Servers](#syslog-servers)
69+
* [Sflow](#sflow)
70+
* [Restapi](#restapi)
71+
* [System Port](#system-port)
72+
* [Tacplus Server](#tacplus-server)
73+
* [TC to Priority group map](#tc-to-priority-group-map)
74+
* [TC to Queue map](#tc-to-queue-map)
75+
* [Telemetry](#telemetry)
76+
* [Telemetry client](#telemetry-client)
77+
* [Tunnel](#tunnel)
78+
* [Versions](#versions)
79+
* [VLAN](#vlan)
80+
* [VLAN_MEMBER](#vlan_member)
81+
* [VNET](#vnet)
82+
* [VOQ Inband Interface](#voq-inband-interface)
83+
* [VXLAN](#vxlan)
84+
* [Virtual router](#virtual-router)
85+
* [LOGGER](#logger)
86+
* [WRED_PROFILE](#wred_profile)
87+
* [XCVRD_LOG](#xcvrd_log)
88+
* [PASSWORD_HARDENING](#password_hardening)
89+
* [SSH_SERVER](#ssh_server)
90+
* [SYSTEM_DEFAULTS table](#systemdefaults-table)
91+
* [RADIUS](#radius)
92+
* [Static DNS](#static-dns)
93+
* [For Developers](#for-developers)
94+
* [Generating Application Config by Jinja2 Template](#generating-application-config-by-jinja2-template)
95+
* [Incremental Configuration by Subscribing to ConfigDB](#incremental-configuration-by-subscribing-to-configdb)
10196

10297

10398
# Introduction
@@ -2919,18 +2914,14 @@ The DPUS table introduces the information on the DPUs (Data Processing Unit) ava
29192914
}
29202915
```
29212916

2922-
#### 5.2.3 Update value directly in db memory
29232917

2924-
For Developers
2925-
==============
2918+
# For Developers
29262919

2927-
Generating Application Config by Jinja2 Template
2928-
------------------------------------------------
2920+
## Generating Application Config by Jinja2 Template
29292921

29302922
To be added.
29312923

2932-
Incremental Configuration by Subscribing to ConfigDB
2933-
----------------------------------------------------
2924+
## Incremental Configuration by Subscribing to ConfigDB
29342925

29352926
Detail instruction to be added. A sample could be found in this
29362927
[PR](https://github.com/Azure/sonic-buildimage/pull/861) that

0 commit comments

Comments
 (0)