Skip to content

About the Change Log Feature

Mike Pawlowski edited this page Dec 8, 2016 · 5 revisions

(a) Overview


  • The Change Log is rendered in the What's New page in the Data Science Experience (DSX) site.
  • There are 3 DevOps deployment environments for the DSX site.
    • See section below: (b) DSX Environments.
  • There are 3 Change Log / What's New pages.
    • Each page corresponds to a DevOps deployment environment for the DSX site.
    • See section below: (c) Environment / Change Log Page Mappings
  • Data for the Change Log is stored in JSON (JavaScript Object Notation) files.
  • These JSON files adhere to a strict format / schema.
  • There are 3 separate JSON files to maintain.
    • Each JSON files corresponds to a DevOps deployment environment for the DSX site.
    • See section below: (d) Environment / Change Log JSON File Mappings.
    • It is important that an environment does not rely on resources from another environment to maintain independence and stability.
    • For this reason, we require 3 separate copies of images referenced by the JSON file.
  • Publishing a new Change Log entry is simply done by committing a change to a JSON file to this GitHub repository.
    • Important: A Change Log entry becomes "live" in it's deployment environment immediately on commit.
    • As a result, extreme care must be taken when making changes.

(b) DSX Environments


YP PROD -- Production Environment

YP QA -- Test Environment

YS1 DEV -- Development Environment

(c) Environment / Change Log Page Mappings


DSX Environment DSX Change Log URL
YS1 DEV https://apsx-dev.stage1.ng.bluemix.net/whats-new
YP QA https://apsx-qa.ng.bluemix.net/whats-new
YP PROD https://apsportal.ibm.com/whats-new

(d) Environment / Change Log JSON File Mappings


DSX Environment Change Log Path
YS1 DEV public/dev/changelog/entries.json
YP QA public/qa/changelog/entries.json
YP PROD public/prod/changelog/entries.json