Process

  1. Open two windows side-by-side with the Firestore console in the samples collection
  2. In one window, open a sample similar to the one you want to add. You can use the filter button and filter by any field to find the right reference sample.
  3. In the other window, click the “Add document” button under samples
  4. Click the “Auto-ID” button to generate an ID for the new sample
  5. Copy the fields from the reference sample and fill the new values
  6. Click “Save”
  7. Confirm the new sample is present and working in the demo system UI

Reference

Sample Fields

Sample fields are type string unless otherwise specified.

These three fields define the type of demo you are creating. You need include only one of these three:

  • images- Only relevant for image demos. An array of image objects to display in this demo’s lightbox. Image fields:
    • img- Filename references a file in demos
    • label- Can be empty
  • link- Relevant for HTML demos. The filename references should be in demos.
  • video- Relevant only for videos. The filename referenced here should be in demos/video_services.

These are the fields that apply to multiple demo types:

  • align- left is fine for a default value
  • description- Can be left blank if not provided
  • height- number type. Copy value from reference sample.
  • id- Not sure this is used anymore. I filled it to be safe. To find the last used id, filter by id but do not provide a condition. Sort ascending in the filter box. Browse for the highest ID.
  • image- File name for the image for this tile. The image should be in the images directory in the demo system (corresponds to public/images in the local copy)
  • image_align- Optional. This determines the background-position that is applied to the image for this tile.
  • launch_height and launch_width- number type. Relevant for course demos and videos.
  • logo- File name for the logo. The logo should be in the logos directory in the demo system (corresponds to public/logos in the local copy)
  • show_description- boolean type. Determines whether the sample is displayed as a simple tile with the tiled overlaid (false) or as an image on one side with text description on the other (true). This is generally false for new demos.
  • tags
  • title- Overlaid on top of the tile when show_description is false or placed above the description when show_description is true
  • width- number type. Copy value from reference sample.