Skip to content

Latest commit

 

History

History
35 lines (27 loc) · 2.11 KB

README.md

File metadata and controls

35 lines (27 loc) · 2.11 KB
Raw

This directory contains the packaged Watson Studio project ZIP file along with any other information required for formal publication.

Packaging instructions

  1. Log in to Watson Studio and create an empty project.
    • Choose meaningful name
    • As description paste the customized content from metadata/project_description
    • Uncheck Restrict who can be a collaborator
  2. In the Overview tab edit the project Readme.
  3. In the Assets tab add every notebook from the notebooks directory to the project.
    • Choose Notebook from File.
    • As notebook name enter the notebook's file name.
    • Add the notebooks' description from the notebook's .description file.
    • Associate the Default Python 3.6 Free ... environment with the notebook.
  4. In the Assets tab add every data file from the data_assets directory to the project.
    • If a data file is compressed decompress it before adding it as a data asset.
  5. Export the project to the desktop.

Validation instructions

  1. Import the exported project from the generated ZIP file.
  2. Verify the readme content.
  3. verify that all notebook output cells are empty.
  4. Verify that the notebook does not contain any hidden cells.
  5. Verify that each notebook works as expected.

Publication instructions

  1. Add the validated exported project archive to the dist directory on GitHub.

The uploaded archive will be used by the content team to publish the project in the Watson Studio Gallery.

Notebook preview instructions

We publish previews of the completed notebooks in Cloud Object Storage and link to them from the data set's landing page. Follow the instructions in https://github.ibm.com/CODAIT/DAX-notebook-previewer to generate the assets. Once you've completed the process, copy the .html files and .json file into this dist directory. The preview files need to be refreshed if a notebook is changed or when a notebook is added.