Skip to content

Add Makefile Configuration Page to Data Handbook #13

Description

@simonprydden

User Story:

As a data engineer,
I want a dedicated page in the data handbook outlining recommended Makefile configurations for data projects,
so that I can quickly and consistently set up build and automation processes for new data projects, reducing setup time and ensuring adherence to best practices.

Acceptance Criteria:

  • A new page titled "Makefile Configuration" is added to the data handbook.
  • The page includes a clear explanation of what a Makefile is and its purpose in data projects.
  • The page provides a sample Makefile configuration with comments, demonstrating common tasks such as:
    • Setting up virtual environments.
    • Installing project dependencies.
    • Running tests.
  • The page includes recommendations on best practices for organizing and structuring Makefiles.
  • The sample configuration is tested and confirmed to be functional.
  • The page is easily accessible and searchable within the data handbook.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions