This page contains a short summary of the project itself. See DEVELOPMENT.md and CONFIGURATION.md for development and configuration instructions.
Template for data pipelines running as containers on Kubernetes, Docker Compose, or cloud. Provides Jupyter Lab based lessons and examples for Python ETL, Apache Superset, Power BI, Spark, Kafka, Argo, etc.
You can create a new project from this template by running taito project create data-pipeline-template. Later you can upgrade your project to the latest version of the template by running taito project upgrade. To ensure flawless upgrade, do not modify files that have a do-not-modify note in them as they are designed to be reusable and easily configurable for various needs. In such case, improve the original files of the template instead, and then upgrade. See Taito CLI for more information.
Short description of the project: vision, purpose, company, etc.
Table of contents:
- Links
- Usage
- Contacts
- Responsibilities
- Intellectual property rights
- Manually configured settings
- Recurring issues and solutions
- Miscellaneous notes
- Conventions
- Architecture Overview
- Security
- Compliance
Non-production basic auth credentials: USERNAME / PASSWORD
LINKS WILL BE GENERATED HERE
You can update this section by configuring links in
scripts/taito/project.shand runningtaito project generate.
Some notes about testing and usage either here or in a separate document.
- Project Manager: John Doe, Company co.
- Designer: Jane Doe, Company co.
NOTE: It is recommended to use a shared address book or CRM for keeping the contact details like email and phone number up-to-date.
Hosting, billing and control of 3rd party services, SSL/TLS certificates, etc.
IPR ownership. Also update the LICENSE file. TODO license examples
Try to keep all configurations in version control. However, if you have configured something manually, describe manually configured settings here.
See trouble.txt or run taito trouble.
Misc notes.
Project specific conventions.
DIAGRAM: You can use Gravizo for making a architecture diagram if the diagram does not contain any confidential information. Note that architecture diagram is not mandatory if the architecture is very simple.
Add short description on integrations and processes, for example as a bullet list.
Add security details either here or in a separate document. See the security appendix of the Taito CLI tutorial.
Add compliance requirements and implementation details either here or in a separate document. For GDPR, see the data protection and privacy appendix of the Taito CLI tutorial.