Introduction

The eleventy-agile-blog is a minimalist blog template built using Eleventy, designed to implement a simple agile development workflow for individual developers or small teams. This project offers a unique approach to managing personal development tasks, writing code, or handling any set of tasks that need completion. It combines blogging with agile methodologies, allowing users to document their progress, plan sprints, and track tasks effectively.

Main Features

1. File-based management system for agile workflow
2. Built-in blog functionality for documenting progress
3. Sprint planning and tracking
4. Backlog and completed tasks management
5. Customizable templates using Eleventy
6. Easy deployment options (local or platforms like Netlify)
7. Minimalist design for focused productivity
8. Git-friendly structure for version control

Installation Steps

1. Clone the repository:

   git clone https://github.com/11ty/eleventy-agile-blog.git my-blog-name
   

2. Navigate to the project directory:

   cd my-blog-name
   

3. Update the .eleventy.js file with your personal details.

4. Install dependencies:

   npm install
   

5. Start the development server:

   npm start
   

Usage Instructions

1. Blog Posts: Write regular blog posts to describe your work, plans, and reflections.

2. Stories: Create "stories" for tasks and add them to the "backlog" using the 'backlog' tag.

3. Sprints: Assign stories to weekly sprints. Create sprint files in the /sprints directory.

4. Implementation: Work on the stories assigned to the current sprint.

5. Completion: Move completed stories to "done" by adding the 'done' tag.

6. Weekly Retrospective: At the end of each week, review your progress and plan for the upcoming week.

7. Git Workflow:

   • Create a weekly branch (e.g., week34)
   • Create story branches from the weekly branch
   • Merge story branches into the weekly branch
   • Merge weekly branches back into master

8. Page Structure:

   • Home: Displays the latest 3 blog posts and useful links
   • Archive: Shows all blog posts
   • Sprints: Lists all sprints
   • Backlog: Displays uncompleted stories
   • Done: Shows completed stories
   • About Me: For personal information and contact details

Important Notes

1. Ensure sprint files in the /sprints directory follow a consistent naming pattern.

2. Use the 'backlog' tag to add stories to the backlog page.

3. Use the 'done' tag to move stories to the done page.

4. Regularly commit your changes to Git to maintain version control.

5. Familiarize yourself with Eleventy's functionality to customize the blog as needed.

6. Consider adding Git aliases to streamline your workflow.

7. The project is open to improvements and pull requests for enhancing the agile workflow implementation.

8. Refer to the week34 retrospective in the blog for a detailed example of the workflow in action.

9. The template is designed to be flexible, allowing adaptation to various personal or small team project management needs.