02. Folder Structures

Repositories

The entire codebase has been divided into 2 repos - Site & Docs.

Docs Repo

• Repo URL -
• This repo contains the content md files.
• Each branch represents a product version.
  • About Master branch:
    • This is the default branch and represent the draft version
    • not allowed to index in search engine by adding meta header robot no-index no-follow by default.
  • Contributions branch:
    • This is branch remains the unversioned and states the contribution guidelines of the site as at a time only one contribution guidelines could be there.
• Each branch contains a version.yaml file which contains following info -
  • Version landing page sections ( Title, link and image )
  • Sidebar data
• To create a new version follow this page

Site Repo

• Repo URL -
• Site repo contains site building code (Jekyll and Marketing Landing Pages)
• This repo also contains -
  • Branches.yaml
    • This yaml file works like a controlling unit of versions. This stores information such as -
      • What all branches / version are to be included in the build
      • Which version is the latest version, published and are allowed to index in search engines.
  • fetch.sh
    • Since the code and content is distributed into 2 repos, during the build process this script fetches all the versions content mentioned in branches.yaml file and place them in right directory.
  • version.sh
    • Once the content is fetched, this scripts works to concat the info from various versions into one file so that site.data.version has details of all version including - title, published state, indexing permission, landing page details (section titles), and sidebar.
    • This makes info available at single point of source