toc branch

Owned by Lakhan Mandloi
Last updated: Jul 17, 2018
1 min read

TOC branch will contain

index.html
widgets.json
robots.txt
css/
js/
images/

Widgets

Types 

  1. Version Switcher ( versions dropdown )

  2. Notification - latest version available on prior versions.

Widget working

  1. Widgets will consume data from the widgets.json file.

  2. widgets.js file generates HTML for widgets and appends them in the empty widget placeholder divs.

widgets.json

  • It will provide data to the widgets

  • Whenever a new version doc is added or removed, this file will have to be updated. 


{
   "versions": [

                       {
                            "version": "2.0",
                            "latest": true
                       },
                       {
                            "version": "1.9",
                            "latest": false
                      },
                      {
                            "version": "1.8",
                           "latest": false
                      }
                 ]
}

Note

  • robots.txt  - If any of the version is unpublished, then that directory will have to be disallowed to be indexed in Search engines.

Related Issues

SB-5499 - Getting issue details... STATUS

SB-5588 - Getting issue details... STATUS