We use "index" Github issues to centralize information about each of our projects and products. It is critical that these issues follow a standard labeling scheme and content format so that DTS' project data is accurate, team members work is coordinated and efficiently tracked, and we have an accessible, high-level view of the project/product on the DTS Website.
{% hint style="info" %}
Create a new Project or Product Index by selecting the appropriate issue template from the atd-data-techGithub repository.
{% endhint %}
All projects which have been scoped require a project index issue to be placed in the appropriate Zenhub pipeline. The issue title, description, and labels should follow the below guidelines.
The issue title should be prefixed with Project: . For example, Project: Warehouse Inventory Management.
Project IndexProject: xzy— A project-specific label that you will create, following our project label conventionsWorkgroup: xyz— the project stakeholder workgroups
All DTS team members who contributed substantially to the project, including at least one product manager or team lead.
Follow the Project Index issue template.
See #index-issue-images below.
All products require a product index issue to be placed in the appropriate Zenhub pipeline. Once a product has been released, it should be placed in the Ongoing pipeline indefinitely until it is removed from service. The issue title, description, and labels should follow the below guidelines.
The issue title should be prefixed with Product: . For example, Product: Data Tracker
Product IndexProduct: xzy— A product-specific label that you will create, following our product label conventionsWorkgroup: xyz— the workgroup(s) of the product's primary users
The product manager.
Follow the Product Index issue template.
See #index-issue-images below.
All projects and products should have at least one image so that missing thumbnails don't disrupt the website design. We prefer these thumbnails options:
- A map or other visualization of the data generated in the app
- Photos of the project/product's end users at work or the related hardware/service; the TPW Flickr feed is a fantastic source for these. We also have a stash of nice photos you can add to or use.
- A close-up screenshot of a unique part of the UI
- For mobile-focused apps, we have a template to show off the application on different devices
Please avoid using
- Full-screen screenshots or large diagrams as the first image - these don't render well in tiles. Include these later on in the issue if they are helpful way to communicate the work.
- Vendor logos - these doesn't give any information about the platform or use case and promote a commercial companies
The image should be at least 1000px wide, with a 3:2 aspect ratio. This tool makes it easy to crop/resize as needed.
