How to Add New Change Log Entries

(0) Background Information

• About the Change Log Feature

(1) Setup Development Environment

• Development Environment Setup Instructions

(2) Get Image for Change Log Entry

• Applicable to the image_url field.
• Format should be Portable Network Graphics (PNG)
• File extension should be lower-case
  • e.g. *.png
• Image resolution should be exactly 479 x 223 pixels.
  • Note: This requirement is too strict.
  • Width should be ~480 pixels and the height natural (flexible).
  • TODO: Need to discuss with Design and DEV teams to rectify in the UI.

(3) Add Image to Local File System

• i.e. Add image to local GitHub repository.
• Add image to 3 locations:
  • (1) datascix/public/dev/changelog/img
  • (2) datascix/public/qa/changelog/img
  • (3) datascix/public/prod/changelog/img
• Each location corresponds to a DevOps deployment environment for the DSX site.
• For more details, see: About the Change Log Feature

(4) Upload Images for Change Log Entry

• i.e. Commit image to remote GitHub repository.
• Important: Do NOT upload any changes related to the JSON Change Log files yet (i.e. entries.json).
• Note: This step seems premature / counter-intuitive; but, is required to validate whether the image URLs resolve correctly via the automated validation script.

(5) Get Blog Entry URL for Change Log Entry

• Applicable to the blog_url field.
• Blog entries are sourced from http://datascience.ibm.com/blog.