From 1864e7709497e0f623a2b2f3f95b229342461a71 Mon Sep 17 00:00:00 2001 From: exequielrafaela Date: Tue, 26 Aug 2025 10:37:24 -0300 Subject: [PATCH 01/13] feat: Add comprehensive Cursor rule for Leverage documentation - Add .cursor/rules/leverage-documentation.mdc with comprehensive context about binbash Leverage ecosystem - Update .gitignore to allow .cursor directory tracking - Includes detailed information about Reference Architecture, IaC Library, and CLI - Provides response guidelines and essential resources for better AI assistance --- .cursor/rules/leverage-documentation.mdc | 161 +++++++++++++++++++++++ .gitignore | 1 + 2 files changed, 162 insertions(+) create mode 100644 .cursor/rules/leverage-documentation.mdc diff --git a/.cursor/rules/leverage-documentation.mdc b/.cursor/rules/leverage-documentation.mdc new file mode 100644 index 000000000..8503021bc --- /dev/null +++ b/.cursor/rules/leverage-documentation.mdc @@ -0,0 +1,161 @@ +--- +description: Binbash Leverage Reference Architecture - Documentation Assistant +globs: ["docs/**/*", "*.md", "mkdocs.yml"] +alwaysApply: true +--- + +# Binbash Leverage Reference Architecture - Documentation Assistant + +You are an AI assistant specialized in binbash Leverage, an enterprise-grade AWS infrastructure-as-code ecosystem that accelerates cloud deployment by up to 10x. You help users with documentation, implementation, architecture decisions, and best practices. + +## Core Understanding + +**Leverage** is a comprehensive AWS cloud infrastructure ecosystem consisting of: + +### 1. **Reference Architecture for AWS** +- **Purpose**: Production-ready, secure, scalable AWS infrastructure following AWS Well-Architected Framework +- **Structure**: Multi-layered approach with logical separation (network, security, shared services, applications) +- **Accounts**: Multi-account setup (Management, Security, Shared, Apps/Workloads) with AWS Organizations +- **Technology**: OpenTofu/Terraform infrastructure-as-code with modular design + +### 2. **Infrastructure-as-Code (IaC) Library** +- **Modules**: 50+ production-ready Terraform/OpenTofu modules covering all AWS services +- **Standards**: Consistent naming, tagging, security, and architectural patterns +- **Coverage**: Network, Security, Compute, Storage, Database, Monitoring, CI/CD, and more +- **Repository**: [le-tf-infra-aws](https://github.com/binbashar/le-tf-infra-aws) + +### 3. **Leverage CLI** +- **Purpose**: Orchestration tool for managing the entire infrastructure lifecycle +- **Features**: Project initialization, credential management, task automation, Docker-based execution +- **Installation**: Available via PyPI (`pip install leverage`) +- **Repository**: [leverage](https://github.com/binbashar/leverage) + +## Key Technologies & AWS Services + +### **Core Technologies** +- **IaC**: OpenTofu, Terraform +- **Orchestration**: Leverage CLI (Python) +- **Configuration**: YAML, HCL +- **Security**: AWS IAM, SSO, SOPS, KMS encryption +- **CI/CD**: Jenkins, ArgoCD, GitHub Actions, CircleCI +- **Containers**: Docker, Kubernetes (EKS), Helm + +### **AWS Services Covered** +- **Compute**: EC2, EKS, ECS, Lambda, Auto Scaling +- **Network**: VPC, Transit Gateway, CloudFront, Route53, ALB/NLB +- **Security**: IAM, SSO, Organizations, GuardDuty, Security Hub, WAF +- **Storage**: S3, EBS, EFS, FSx +- **Database**: RDS (MySQL, PostgreSQL), DynamoDB, ElastiCache +- **Monitoring**: CloudWatch, CloudTrail, Config, X-Ray +- **Management**: Systems Manager, Secrets Manager, Parameter Store + +## Architecture Concepts + +### **Layer Structure** +1. **Network Layer**: VPC, subnets, routing, security groups +2. **Security Layer**: IAM roles, policies, encryption, compliance +3. **Shared Layer**: Common services (monitoring, logging, DNS) +4. **Apps Layer**: Application-specific infrastructure + +### **Account Organization** +- **Management Account**: AWS Organizations, billing, governance +- **Security Account**: Centralized security services, audit logs +- **Shared Account**: Common services, CI/CD, monitoring +- **Apps/Workload Accounts**: Application environments (dev, staging, prod) + +### **Project Structure** +``` +project/ +├── config/ # Configuration files +├── management/ # Management account resources +├── security/ # Security account resources +├── shared/ # Shared services account +└── apps/ # Application accounts + ├── devstg/ # Development/Staging + └── prd/ # Production +``` + +## Documentation Structure + +### **Main Documentation Sections** +- **Concepts**: What is Leverage, tech stack, benefits +- **Try Leverage**: Step-by-step setup guide +- **User Guide**: + - Reference Architecture AWS (features, workflow, configuration) + - Leverage CLI (installation, commands, extending) + - Infrastructure Library (modules, specs, forks) + - Troubleshooting +- **How It Works**: Architecture considerations +- **Work With Us**: Support, roadmap, contributions + +### **Key Feature Documentation** +- **CI/CD**: Jenkins, ArgoCD, Spinnaker integration +- **Compute**: EKS, ECS, EC2, service mesh +- **Network**: DNS, Transit Gateway, VPC design +- **Security**: Certificates, audit, compliance, WAF +- **Monitoring**: Metrics, logs, APM +- **Database**: RDS, DynamoDB configurations +- **Storage**: S3, backup strategies + +## Essential Resources + +### **Primary Documentation** +- [Leverage Documentation](https://leverage.binbash.co) — Complete framework documentation +- [High-Level Overview](https://www.binbash.co/leverage) — Business and technical overview + +### **Core Repositories** +- [Reference Architecture Code](https://github.com/binbashar/le-tf-infra-aws) — Main Terraform/OpenTofu codebase +- [Leverage CLI](https://github.com/binbashar/leverage) — Command-line orchestration tool +- [Terraform Modules List](https://github.com/binbashar/le-dev-tools/blob/master/terraform/Makefile) — Complete module inventory + +### **Additional Resources** +- [Documentation Repository](https://github.com/binbashar/le-ref-architecture-doc) — This documentation source +- [PyPI Package](https://pypi.org/project/leverage) — CLI installation + +## Response Guidelines + +### **When helping users:** + +1. **Always Reference Official Sources**: Use the linked documentation and repositories as primary truth +2. **Follow AWS Well-Architected**: Ensure recommendations align with AWS best practices +3. **Layer-Based Thinking**: Consider the multi-layer architecture approach +4. **Multi-Account Context**: Account for the multi-account organizational structure +5. **Module-First Approach**: Leverage existing modules before custom solutions +6. **Security by Design**: Emphasize security, compliance, and governance +7. **Practical Implementation**: Provide actionable, tested guidance +8. **CLI Integration**: Show how to use Leverage CLI for operations + +### **For architecture questions:** +- Reference specific documentation sections +- Consider layer dependencies and account boundaries +- Align with AWS Well-Architected pillars +- Use established patterns from the reference architecture + +### **For module usage:** +- Check the Makefile for latest module versions +- Reference module documentation and examples +- Consider integration with existing infrastructure +- Follow established naming and tagging conventions + +### **For CLI operations:** +- Show specific leverage commands +- Reference credential management +- Consider Docker-based execution context +- Provide troubleshooting guidance + +### **For troubleshooting:** +- Reference troubleshooting documentation +- Consider common credential and configuration issues +- Verify layer dependencies and account setup +- Check CLI version compatibility + +## Implementation Priorities + +1. **Security First**: Always prioritize security and compliance requirements +2. **Scalability**: Design for growth and changing requirements +3. **Maintainability**: Use established patterns and modules +4. **Cost Optimization**: Consider resource efficiency and cost management +5. **Operational Excellence**: Implement monitoring, automation, and best practices +6. **Reliability**: Design for high availability and disaster recovery + +Use this knowledge to provide accurate, actionable guidance for implementing and managing AWS infrastructure with the Leverage ecosystem. \ No newline at end of file diff --git a/.gitignore b/.gitignore index 4bd536e9d..7f5eedb95 100644 --- a/.gitignore +++ b/.gitignore @@ -15,6 +15,7 @@ !/.github !*.gitkeep !*.editorconfig +!/.cursor # SSH keys # ############ From 3a89e729c701a6755974f436ec86ce0fb5d51417 Mon Sep 17 00:00:00 2001 From: exequielrafaela Date: Tue, 26 Aug 2025 10:43:22 -0300 Subject: [PATCH 02/13] feat: Add Claude AI guidance file - Add CLAUDE.md with comprehensive repository and project context - Remove duplicate cursor rule file without proper metadata - Provides guidance for Claude AI when working with documentation --- CLAUDE.md | 120 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 120 insertions(+) create mode 100644 CLAUDE.md diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 000000000..a21d42f85 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,120 @@ +# CLAUDE.md + +This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. + +## Project Overview + +This is the documentation repository for **binbash Leverage™**, a comprehensive AWS cloud infrastructure reference architecture built with MkDocs Material. The site is deployed at https://leverage.binbash.co and documents a production-ready AWS infrastructure-as-code ecosystem. + +## Common Commands + +### Development +```bash +make init-makefiles # Initialize external makefile dependencies (first time only) +make docs-live # Start local development server at http://localhost:8000 +make docs-check-dead-links # Check if documentation contains dead links +make help # Show all available commands +``` + +### Deployment +```bash +make docs-deploy-gh # Deploy to GitHub Pages +``` + +### Additional Available Commands +```bash +make circleci-validate-config # Validate CircleCI configuration +make changelog-init # Initialize git-chglog +make changelog-{major|minor|patch} # Generate changelog for release +make release-{major|minor|patch} # Create releases +``` + +## Architecture and Structure + +### Build System +- **MkDocs Material**: Static site generator with Docker-based builds +- **Modular Makefiles**: External makefile dependencies from `le-dev-makefiles` (v0.2.18) +- **Docker Required**: All operations require Docker daemon running + +### Key Directories +- `docs/` - Markdown documentation source files +- `docs/assets/` - Images, diagrams, stylesheets, and static assets +- `docs/assets/diagrams/editable/` - Editable DrawIO diagram sources +- `material/overrides/` - Custom MkDocs Material theme templates +- `site/` - Generated static HTML output (auto-generated) +- `@bin/makefiles/` - External makefile dependencies (auto-generated) + +### Configuration Files +- `mkdocs.yml` - Complete MkDocs configuration with navigation structure +- `Makefile` - Build automation entry point +- `.cursorrules` - AI assistant guidelines for binbash Leverage ecosystem + +## Content Organization + +The documentation follows a structured approach: + +1. **Concepts** - Introduction and core concepts +2. **Try Leverage** - Getting started guides +3. **User Guide** - Comprehensive documentation covering: + - AWS Reference Architecture + - Leverage CLI usage + - Infrastructure library modules + - Troubleshooting guides +4. **Work With Us** - Community and business information + +## Development Workflow + +### Local Development +1. Ensure Docker daemon is running +2. Run `make init-makefiles` (first time only) +3. Run `make docs-live` for real-time preview at http://localhost:8000 +4. Edit Markdown files in `docs/` directory +5. Changes appear automatically in browser + +### Content Guidelines +- Follow existing content structure and navigation defined in `mkdocs.yml` +- Place images in `docs/assets/images/` with appropriate subdirectories +- Use DrawIO for editable diagrams, store sources in `docs/assets/diagrams/editable/` +- Follow binbash Leverage terminology and concepts as defined in `.cursorrules` + +### Deployment Process +- **Branches**: `master` for source, `gh-pages` for deployed site +- **CI/CD**: Automatic deployment via CircleCI when merged to master +- **Manual Deploy**: Use `make docs-deploy-gh` if needed + +## Technical Notes + +### Dependencies +- Docker container uses `squidfunk/mkdocs-material` image +- External makefiles from `binbashar/le-dev-makefiles` repository +- Material theme customizations in `material/` directory + +### Site Configuration +- Multi-language support (English/Spanish) +- Google Analytics integration +- Dark/light mode toggle +- Navigation tabs and search functionality +- Custom favicon and branding + +### Diagram Management +- Editable sources in `docs/assets/diagrams/editable/` (DrawIO format) +- Some diagrams exported from shared Google Slides presentation +- Export PNGs to `docs/assets/images/diagrams/` for documentation use +- Use consistent naming conventions for diagrams across the documentation + +## Important Instructions for AI Assistants + +### binbash Leverage Context +This documentation covers the **binbash Leverage™** ecosystem - an enterprise-grade AWS infrastructure-as-code framework. When working with this repository, you should understand: + +- **Reference Architecture**: Production-ready, multi-account AWS infrastructure following AWS Well-Architected Framework +- **Infrastructure Library**: 50+ Terraform/OpenTofu modules for AWS services +- **Leverage CLI**: Python-based orchestration tool for managing infrastructure lifecycle +- **Multi-layered Architecture**: Network, Security, Shared, and Apps layers with clear separation of concerns +- **Multi-account Strategy**: Management, Security, Shared, and Application accounts with AWS Organizations + +### Content Guidelines +- Follow binbash Leverage terminology and architectural concepts as defined in `.cursorrules` +- Maintain consistency with existing documentation structure and navigation +- Reference the comprehensive knowledge base in `.cursorrules` for accurate technical details +- Always consider the multi-account, multi-layer context when making recommendations \ No newline at end of file From 456ac58b22078a63c68df01a58353389d4e34ff4 Mon Sep 17 00:00:00 2001 From: exequielrafaela Date: Tue, 26 Aug 2025 10:44:11 -0300 Subject: [PATCH 03/13] renaming cursor leverage doc rule --- .../{leverage-documentation.mdc => doc-binbash-leverage.mdc} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .cursor/rules/{leverage-documentation.mdc => doc-binbash-leverage.mdc} (100%) diff --git a/.cursor/rules/leverage-documentation.mdc b/.cursor/rules/doc-binbash-leverage.mdc similarity index 100% rename from .cursor/rules/leverage-documentation.mdc rename to .cursor/rules/doc-binbash-leverage.mdc From 8832df939ec9f582fefda1a93a7dd1b765a950af Mon Sep 17 00:00:00 2001 From: exequielrafaela Date: Tue, 26 Aug 2025 17:44:32 -0300 Subject: [PATCH 04/13] feat: Complete Issue #150 - Comprehensive Contributing section - Rename 'Contribute' to 'Contributing' in navigation - Transform docs/work-with-us/contribute.md into comprehensive ecosystem guide - Update CONTRIBUTING.md for documentation-specific contributions - Fix email addresses to use leverage@binbash.co - Update copyright year to 2025 - Update Terraform modules link to GitHub topics - Remove duplicate sections and unify contributing guidance - Provide clear pathways for all types of contributions Resolves #150 --- CONTRIBUTING.md | 309 +++++++++++++++++++++++++++++--- docs/work-with-us/contribute.md | 86 ++++++--- mkdocs.yml | 4 +- 3 files changed, 342 insertions(+), 57 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ac460c12a..90e7d43f9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,39 +1,296 @@ -# Contributing +# Contributing to binbash Leverage Documentation -When contributing, please discuss the change you wish to make via issue -with the owners of this repository before making a change. +Thank you for your interest in contributing to the **binbash Leverage** documentation! This repository contains the comprehensive documentation for the Leverage ecosystem, and we welcome contributions from the community. -Please note we have a code of conduct, please follow it in all your interactions with the project. +## 📚 About This Repository -## Pull Request Process +This repository contains the source code for the [Leverage documentation website](https://leverage.binbash.co), built with MkDocs Material. The documentation covers: -1. Make sure that all build or compilation dependencies are removed when performing a build. -2. Update the README.md with details of changes to the interface, this includes new environment - variables, exposed ports, useful file locations and container parameters. -3. Increase the version numbers in any examples files and the README.md to the new version that this - Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). -4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you - do not have permission to do that, you may request the second reviewer to merge it for you. +- **Concepts**: Introduction and core principles +- **Try Leverage**: Getting started guides +- **User Guide**: Comprehensive implementation documentation +- **How It Works**: Architecture deep dives +- **Work With Us**: Community and business information +## 🚀 Quick Start -### Collaborate on fixes for security vulnerabilities in private forks +### Prerequisites -Working in the open means that it is impossible to hide things. And yet, sometimes you will want -to work on some changes to the code in private, for example when fixing a security vulnerability. +- **Docker**: Required for running the documentation locally +- **Git**: For version control +- **Make**: For running build commands -Working on a fix in the open might allow attackers to reverse engineer the bug and attack our users. -Since GitHub provides a mechanism to easily create a private fork of our repo, please use these -private forks to collaborate on a security fix. +### Local Development -### Publish maintainer advisories for security fixes +1. **Fork and Clone**: + ```bash + git clone https://github.com/YOUR_USERNAME/le-ref-architecture-doc.git + cd le-ref-architecture-doc + ``` -Fixing a security vulnerability is no small feat and we should tell our users about it. -We will do it in a way that will make it easy for you to learn about it and patch +2. **Initialize Environment**: + ```bash + make init-makefiles # First time only + ``` -Since GitHub provides an easy way to publish a security advisory, this will -be incorporated and you could add it into your security scanning tools, the ones you -depend on to keep your applications secure. +3. **Start Development Server**: + ```bash + make docs-live + ``` + Visit [http://localhost:8000](http://localhost:8000) for live preview. -## Read More +4. **Check for Issues**: + ```bash + make docs-check-dead-links # Verify all links work + ``` -[Leverage Open Source Modules management](https://leverage.binbash.com.ar/how-it-works/infra-as-code-library/infra-as-code-library-forks/) +## 📋 How to Contribute + +### 1. Planning Your Contribution + +- **Check Issues**: Look for existing [documentation issues](https://github.com/binbashar/le-ref-architecture-doc/issues?q=is%3Aissue+is%3Aopen+label%3Adocumentation) +- **Discuss First**: For major changes, create an issue to discuss your proposal +- **Small Fixes**: Minor corrections can be submitted directly as PRs + +### 2. Types of Contributions + +#### Content Improvements +- Fix typos, grammar, and formatting +- Improve clarity and readability +- Add missing information +- Update outdated content +- Add practical examples + +#### New Documentation +- Tutorials and how-to guides +- Architecture explanations +- Best practices documentation +- Troubleshooting guides + +#### Technical Improvements +- Fix broken links +- Improve navigation structure +- Enhance visual elements +- Optimize performance + +### 3. Contribution Workflow + +1. **Create a Branch**: + ```bash + git checkout -b docs/your-improvement-description + ``` + +2. **Make Changes**: + - Edit Markdown files in the `docs/` directory + - Follow our [style guide](#writing-style-guide) + - Test changes locally with `make docs-live` + +3. **Validate Changes**: + ```bash + make docs-check-dead-links + ``` + +4. **Commit Changes**: + ```bash + git add . + git commit -m "docs: brief description of changes" + ``` + +5. **Submit Pull Request**: + - Use our [PR template](#pull-request-guidelines) + - Provide clear description of changes + - Reference any related issues + +## 📝 Writing Style Guide + +### General Principles + +- **Clear and Concise**: Use simple, direct language +- **User-Focused**: Write from the user's perspective +- **Actionable**: Provide specific, executable instructions +- **Consistent**: Follow existing patterns and terminology + +### Formatting Standards + +#### Headings +```markdown +# Page Title (H1 - only one per page) +## Main Section (H2) +### Subsection (H3) +#### Details (H4) +``` + +#### Code Blocks +```markdown +# For shell commands +```bash +leverage aws configure +``` + +# For configuration files +```yaml +site_name: binbash Leverage +``` + +# For Terraform +```hcl +resource "aws_instance" "example" { + ami = "ami-12345678" +} +``` +``` + +#### Links and References +```markdown +# Internal links (preferred) +[Installation Guide](/user-guide/leverage-cli/installation/) + +# External links +[AWS Documentation](https://docs.aws.amazon.com/) + +# Reference-style links for repeated URLs +[binbash Leverage][leverage-home] + +[leverage-home]: https://leverage.binbash.co +``` + +#### Admonitions +```markdown +!!! info "Information" + Use for helpful tips and additional information. + +!!! warning "Warning" + Use for important caveats and potential issues. + +!!! danger "Important" + Use for critical information and breaking changes. + +!!! example "Example" + Use for code examples and practical demonstrations. +``` + +### Content Guidelines + +#### Technical Accuracy +- Test all code examples +- Verify command outputs +- Keep version information current +- Reference official sources + +#### Terminology +- Use "Leverage" when referring to the entire ecosystem +- Use "Reference Architecture" for the AWS infrastructure code +- Use "Leverage CLI" for the command-line tool +- Be consistent with AWS service names + +#### Structure +- Start with overview/introduction +- Provide prerequisites +- Include step-by-step instructions +- Add troubleshooting information +- Link to related documentation + +## 🔍 Pull Request Guidelines + +### PR Title Format +Use conventional commit format: +``` +docs: brief description of changes +docs(section): description for specific section changes +fix(docs): description for bug fixes +feat(docs): description for new features +``` + +### PR Description Template +```markdown +## Description +Brief description of what this PR changes. + +## Type of Change +- [ ] Content improvement (typos, clarity, accuracy) +- [ ] New documentation +- [ ] Technical fix (links, formatting) +- [ ] Structure/navigation improvement + +## Testing +- [ ] Tested locally with `make docs-live` +- [ ] Checked for broken links with `make docs-check-dead-links` +- [ ] Verified all code examples work + +## Related Issues +Fixes #issue_number (if applicable) +``` + +### Review Process + +1. **Automated Checks**: PRs run through CI/CD validation +2. **Content Review**: Maintainers review for accuracy and style +3. **Technical Review**: Check for broken links and formatting +4. **Approval**: Requires approval from project maintainers +5. **Merge**: Maintainers will merge approved changes + +## 🔒 Security Guidelines + +### Security-Related Documentation + +- **Never include**: Real credentials, private keys, or sensitive information +- **Use placeholders**: `YOUR_AWS_ACCOUNT_ID`, `YOUR_REGION`, etc. +- **Security vulnerabilities**: Report privately to [security@binbash.co](mailto:security@binbash.co) + +### Sensitive Content Review + +For documentation involving security configurations: +1. Create a private fork for initial development +2. Request security review before making public +3. Follow coordinated disclosure for security-related content + +## 🛠️ Project Structure + +``` +le-ref-architecture-doc/ +├── docs/ # Documentation source files +│ ├── assets/ # Images, diagrams, styles +│ ├── concepts/ # Introduction and concepts +│ ├── try-leverage/ # Getting started guides +│ ├── user-guide/ # Comprehensive documentation +│ ├── how-it-works/ # Architecture details +│ └── work-with-us/ # Community information +├── material/ # Theme customizations +│ └── overrides/ # Custom templates +├── mkdocs.yml # Site configuration +├── Makefile # Build automation +└── README.md # Repository information +``` + +## Recognition + +We appreciate all contributions to the documentation: + +- **Contributors**: Listed in commit history and release notes +- **Significant Contributions**: Acknowledged in documentation +- **Outstanding Contributors**: May be invited to join the documentation team + +## 📞 Support and Resources + +### Getting Help + +- **Documentation Issues**: [Create an issue](https://github.com/binbashar/le-ref-architecture-doc/issues/new) +- **Direct Support**: [leverage@binbash.co](mailto:leverage@binbash.co) + +### Additional Resources + +- [Leverage Documentation](https://leverage.binbash.co) - Published documentation +- [MkDocs Material](https://squidfunk.github.io/mkdocs-material/) - Theme documentation +- [Markdown Guide](https://www.markdownguide.org/) - Markdown syntax reference +- [Conventional Commits](https://www.conventionalcommits.org/) - Commit message format + +### Complementary Contributing Guide + +For detailed information about contributing to to Other Leverage Framework Projects +inside our ecosystem (not just documentation), see our comprehensive [Contributing Guide](https://leverage.binbash.co/work-with-us/contributing/). + +--- + +**Thank you for helping make Leverage documentation better!** 🚀 + +Your contributions help users deploy AWS infrastructure faster, more securely, and with greater confidence. diff --git a/docs/work-with-us/contribute.md b/docs/work-with-us/contribute.md index a5f6b0d4b..a38e80c30 100644 --- a/docs/work-with-us/contribute.md +++ b/docs/work-with-us/contribute.md @@ -1,46 +1,74 @@ -# Contribute and Developing binbash Leverage +# Contributing to binbash Leverage -This document explains how to get started with developing for **Leverage Reference Architecture**. -It includes how to build, test, and [release](https://github.com/binbashar/le-tf-infra-aws/releases) new versions. +Thank you for your interest in contributing to **binbash Leverage**! This guide covers how to contribute to documentation and other parts of the Leverage ecosystem. You're in the right place - continue reading below to find the right project for your interests. -## Quick Start +## How You Can Contribute -### Getting the code +### 📝 Documentation Contributions -The code must be checked out from this same github.com repo inside the -[binbash Leverage Github Organization](https://github.com/binbashar). +- **Fix errors**: Correct technical inaccuracies and outdated information +- **Improve clarity**: Make explanations easier to understand +- **Add examples**: Include practical code examples and use cases +- **Fill gaps**: Add missing documentation or troubleshooting sections +- **Fix broken links**: Ensure all references are working +- **Improve formatting**: Enhance readability and visual presentation -``` -git clone git@github.com:binbashar/le-tf-infra-aws.git -cd le-tf-infra-aws -cd .. +### 🏗️ Infrastructure & Code Contributions -git clone git@github.com:binbashar/le-ansible-infra.git -cd le-ansible-infra -cd .. -``` +- **Reference Architecture**: Improve AWS infrastructure layers and multi-account setup +- **Terraform Modules**: Enhance existing modules or create new ones for AWS services +- **Leverage CLI**: Add new features, improve user experience, and optimize performance +- **Bug Fixes**: Help identify and resolve issues across all projects +- **Testing**: Add or improve automated testing and validation -### Initial developer environment build +## 🚀 Quick Start -**TODO** +### For Documentation Contributions -## Dependencies +1. **Fork** this repository on GitHub: [le-ref-architecture-doc](https://github.com/binbashar/le-ref-architecture-doc) +2. **Clone** and setup: + ```bash + git clone https://github.com/YOUR_USERNAME/le-ref-architecture-doc.git + cd le-ref-architecture-doc + make init-makefiles # First time only + make docs-live # Visit http://localhost:8000 + ``` -This guide requires you to install X v0.1 or newer. +### For Other Project Contributions +Choose the repository that matches your interests: -## Deploying +- **[Reference Architecture](https://github.com/binbashar/le-tf-infra-aws)**: AWS infrastructure code +- **[CLI Tool](https://github.com/binbashar/leverage)**: Command-line interface +- **[Terraform Modules](https://github.com/topics/binbash-terraform)**: 50+ AWS modules -To deploy the Leverage Reference Architecture onto AWS. -Please check the [deployment guide](./deploy/) +Each repository has setup instructions in its README file. -## Testing +## 📝 Contributing Process -To run tests, just run... +### General Workflow -## Releasing -### CircleCi PR auto-release job +1. **Choose your project**: Pick from documentation, infrastructure, CLI, or modules +2. **Fork and clone**: Fork the relevant repository and clone your fork +3. **Create a branch**: Use descriptive names like `feat/new-feature` or `docs/improve-guide` +4. **Make changes**: Follow the project's specific guidelines +5. **Test locally**: Verify your changes work as expected +6. **Submit PR**: Create a clear pull request with description -![circleci-logo](/assets/images/logos/circleci.png "CircleCI"){: style="width:150px"} +### Project-Specific Guidelines -- -- **NOTE:** Will only run after merged PR. \ No newline at end of file +- **Documentation**: Use clear language, test examples, check links +- **Infrastructure**: Follow AWS Well-Architected principles, include examples +- **CLI**: Include tests, follow Python best practices, update documentation +- **Modules**: Maintain consistency, add comprehensive documentation + +## 📞 Getting Help + +Need assistance? Here's how to get help: + +1. **Check existing documentation** and GitHub issues +3. **Report issues** in this repository +4. **Email support**: [leverage@binbash.co](mailto:leverage@binbash.co) + +--- + +**Thank you for contributing to binbash Leverage!** Your contributions help make cloud infrastructure more accessible and reliable for everyone! 🚀 \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index de5f50e3b..bf74acf02 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,7 +8,7 @@ repo_url: https://github.com/binbashar/le-ref-architecture-doc site_url: https://leverage.binbash.co/ site_description: binbash Leverage Reference Architecture Documentation site_author: binbash -copyright: Copyright © 2017-2023 binbash +copyright: Copyright © 2017-2025 binbash #===================================================================================# # Mkdocs Theme (Material Mkdocs) + Extras @@ -319,7 +319,7 @@ nav: - Versions compatibility matrix: "work-with-us/releases/versions-compatibility-matrix.md" - Leverage vs Competition: "work-with-us/leverage-vs-competition.md" #- Subscription Plans: "work-with-us/subscription-plans.md" - - Contribute: "work-with-us/contribute.md" + - Contributing: "work-with-us/contribute.md" - Roadmap: - Reference Architecture: - Overview: "work-with-us/roadmap/ref-arch/overview.md" From 5bc7095cf590417087f38e73f48f029ad5fa3089 Mon Sep 17 00:00:00 2001 From: exequielrafaela Date: Tue, 26 Aug 2025 17:55:45 -0300 Subject: [PATCH 05/13] Polishing README.md based on latest improvements --- README.md | 117 +++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 93 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index c2d15856e..315461ce3 100644 --- a/README.md +++ b/README.md @@ -5,38 +5,107 @@ # binbash Leverage™ Documentation +[![Documentation Status](https://img.shields.io/badge/docs-leverage.binbash.co-blue)](https://leverage.binbash.co) +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +[![GitHub Issues](https://img.shields.io/github/issues/binbashar/le-ref-architecture-doc)](https://github.com/binbashar/le-ref-architecture-doc/issues) + ## Overview -This repository contains all files used to create -[binbash Leverage Reference Documentation](https://leverage.binbash.co) -### Branches -- `master` --> contains the source code -- `gh-pages` --> deployable (builded) version +This repository contains the comprehensive documentation for **binbash Leverage™**, an enterprise-grade AWS infrastructure-as-code ecosystem that accelerates cloud deployment by up to 10x. + +**🌐 Live Documentation:** [leverage.binbash.co](https://leverage.binbash.co) + +### What is Leverage? + +Leverage is a complete AWS cloud infrastructure framework consisting of: + +- **🏗️ Reference Architecture**: Production-ready, multi-account AWS infrastructure following AWS Well-Architected Framework +- **📚 Infrastructure Library**: 50+ Terraform/OpenTofu modules covering all AWS services +- **⚡ CLI Tool**: Python-based orchestration tool for infrastructure lifecycle management + +## 🚀 Getting Started + +### Documentation Structure + +The documentation covers everything you need to know about Leverage: + +- **💡 Concepts**: Core principles and architecture overview +- **🎯 Try Leverage**: Step-by-step tutorial to deploy your first AWS infrastructure +- **📖 User Guide**: Comprehensive implementation guides for all components +- **🔧 How It Works**: Deep dives into architecture and design decisions +- **🤝 Work With Us**: Community, support, and contribution information + +### Repository Structure + +- **`master` branch**: Documentation source code (Markdown files) +- **`gh-pages` branch**: Auto-deployed documentation site +- **`docs/`**: All documentation content organized by topic +- **`material/`**: Custom MkDocs Material theme overrides +- **`mkdocs.yml`**: Site configuration and navigation structure + +## 🤝 Contributing + +We welcome contributions to improve the documentation and the entire binbash Leverage ecosystem! -## Deployed Documentation -Check it out [here](https://leverage.binbash.co/). +### Contributing to Documentation -## Development / Contributing +1. **Fork** this repository +2. **Clone** your fork and set up the development environment: + ```bash + git clone https://github.com/YOUR_USERNAME/le-ref-architecture-doc.git + cd le-ref-architecture-doc + make init-makefiles # First time only + make docs-live # Visit http://localhost:8000 + ``` +3. **Make your changes** and test locally +4. **Submit a pull request** with clear description + +### Contributing to Other Leverage Projects + +Interested in contributing to the broader Leverage ecosystem? + +- **🏗️ [Reference Architecture](https://github.com/binbashar/le-tf-infra-aws)**: AWS infrastructure code +- **⚡ [CLI Tool](https://github.com/binbashar/leverage)**: Command-line interface +- **📚 [Terraform Modules](https://github.com/topics/binbash-terraform)**: 50+ AWS modules + +📋 **Detailed Guidelines**: See our [Contributing Guide](CONTRIBUTING.md) for documentation-specific guidelines, or visit our [comprehensive contributing guide](https://leverage.binbash.co/work-with-us/contributing/) for all projects. + +## 🛠️ Development + +### Technology Stack + +- **📝 Documentation Generator**: [MkDocs Material](https://squidfunk.github.io/mkdocs-material/) +- **🐳 Development Environment**: Docker-based for consistency +- **🔄 Auto-Deployment**: CircleCI pipeline to GitHub Pages +- **🎨 Theme**: Custom Material theme with binbash branding + +### Available Commands -1. Clone the repo locally -2. Config your MkDocs env including the navigation tree directory via `mkdocs.yml` file. -3. Spin up your MkDocs local dev web server environment (`http://localhost:8000`) (real time updates we'll be shown) (docker daemon needed) via `Makefile` cmd ```bash - make init-makefiles # needed only the first time - make docs-live +make help # Show all available commands +make init-makefiles # Initialize external makefile dependencies +make docs-live # Start local development server +make docs-deploy-gh # Deploy to GitHub Pages +make docs-check-dead-links # Validate all links (requires GNU tools) ``` -4. Update necessary `*.md` files inside the `docs/` folder and check your updates through the local environment -browser -5. And create your PR from `BBL-XXX` to `master` branch. -6. The Github Pages site [https://leverage.binbash.co](https://leverage.binbash.co/) will be automatically deployed -via CircleCI job to the `gh-pages` branch (currently being built from this branch). - - It currently uses the `make docs-deploy-gh` cmd which could be locally executed if needed too. -### TODO -- Several sections needs completion or update. +### Diagrams and Assets + +- **📊 Editable Diagrams**: Located in `docs/assets/diagrams/editable/` (DrawIO format) +- **🖼️ Static Images**: Exported diagrams and screenshots in `docs/assets/images/` +- **🎨 Logos**: Brand assets in `docs/assets/images/logos/` + +## 📞 Support + +- **📖 Documentation**: [leverage.binbash.co](https://leverage.binbash.co) +- **💬 Community**: [GitHub Discussions](https://github.com/binbashar/leverage/discussions) +- **🐛 Issues**: [Report bugs or request features](https://github.com/binbashar/le-ref-architecture-doc/issues) +- **✉️ Contact**: [leverage@binbash.co](mailto:leverage@binbash.co) + +## 📄 License -## About Diagrams +Copyright © 2017-2025 [binbash](https://www.binbash.co). This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE.md) file for details. -Some of them have editable version under `docs/assets/diagrams/editable`. +--- -Others are directly exported from `https://docs.google.com/presentation/d/1t2SWgWlGvuIOqYHkpzxQSVLafI_MCsA3gNz6Kkyf6TE/edit#slide=id.p6`. +**Made with ❤️ by the [binbash](https://www.binbash.co) team** From fac152f24aeb10573c8dac6bbe262faf99a3e7e4 Mon Sep 17 00:00:00 2001 From: exequielrafaela Date: Tue, 26 Aug 2025 18:00:43 -0300 Subject: [PATCH 06/13] improve README.md --- README.md | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 315461ce3..ef1eb70de 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ This repository contains the comprehensive documentation for **binbash Leverage™**, an enterprise-grade AWS infrastructure-as-code ecosystem that accelerates cloud deployment by up to 10x. -**🌐 Live Documentation:** [leverage.binbash.co](https://leverage.binbash.co) +**Live Documentation:** [leverage.binbash.co](https://leverage.binbash.co) ### What is Leverage? @@ -29,11 +29,11 @@ Leverage is a complete AWS cloud infrastructure framework consisting of: The documentation covers everything you need to know about Leverage: -- **💡 Concepts**: Core principles and architecture overview -- **🎯 Try Leverage**: Step-by-step tutorial to deploy your first AWS infrastructure -- **📖 User Guide**: Comprehensive implementation guides for all components -- **🔧 How It Works**: Deep dives into architecture and design decisions -- **🤝 Work With Us**: Community, support, and contribution information +- **Concepts**: Core principles and architecture overview +- **Try Leverage**: Step-by-step tutorial to deploy your first AWS infrastructure +- **User Guide**: Comprehensive implementation guides for all components +- **How It Works**: Deep dives into architecture and design decisions +- **Work With Us**: Community, support, and contribution information ### Repository Structure @@ -64,20 +64,20 @@ We welcome contributions to improve the documentation and the entire binbash Lev Interested in contributing to the broader Leverage ecosystem? -- **🏗️ [Reference Architecture](https://github.com/binbashar/le-tf-infra-aws)**: AWS infrastructure code -- **⚡ [CLI Tool](https://github.com/binbashar/leverage)**: Command-line interface -- **📚 [Terraform Modules](https://github.com/topics/binbash-terraform)**: 50+ AWS modules +- **[Reference Architecture](https://github.com/binbashar/le-tf-infra-aws)**: AWS infrastructure code +- **[CLI Tool](https://github.com/binbashar/leverage)**: Command-line interface +- **[Terraform Modules](https://github.com/topics/binbash-terraform)**: 50+ AWS modules -📋 **Detailed Guidelines**: See our [Contributing Guide](CONTRIBUTING.md) for documentation-specific guidelines, or visit our [comprehensive contributing guide](https://leverage.binbash.co/work-with-us/contributing/) for all projects. +**Detailed Guidelines**: See our [Contributing Guide](CONTRIBUTING.md) for documentation-specific guidelines, or visit our [comprehensive contributing guide](https://leverage.binbash.co/work-with-us/contributing/) for all projects. ## 🛠️ Development ### Technology Stack -- **📝 Documentation Generator**: [MkDocs Material](https://squidfunk.github.io/mkdocs-material/) -- **🐳 Development Environment**: Docker-based for consistency -- **🔄 Auto-Deployment**: CircleCI pipeline to GitHub Pages -- **🎨 Theme**: Custom Material theme with binbash branding +- **Documentation Generator**: [MkDocs Material](https://squidfunk.github.io/mkdocs-material/) +- **Development Environment**: Docker-based for consistency +- **Auto-Deployment**: CircleCI pipeline to GitHub Pages +- **Theme**: Custom Material theme with binbash branding ### Available Commands @@ -91,16 +91,16 @@ make docs-check-dead-links # Validate all links (requires GNU tools) ### Diagrams and Assets -- **📊 Editable Diagrams**: Located in `docs/assets/diagrams/editable/` (DrawIO format) -- **🖼️ Static Images**: Exported diagrams and screenshots in `docs/assets/images/` -- **🎨 Logos**: Brand assets in `docs/assets/images/logos/` +- **Editable Diagrams**: Located in `docs/assets/diagrams/editable/` (DrawIO format) +- **Static Images**: Exported diagrams and screenshots in `docs/assets/images/` +- **Logos**: Brand assets in `docs/assets/images/logos/` ## 📞 Support -- **📖 Documentation**: [leverage.binbash.co](https://leverage.binbash.co) -- **💬 Community**: [GitHub Discussions](https://github.com/binbashar/leverage/discussions) -- **🐛 Issues**: [Report bugs or request features](https://github.com/binbashar/le-ref-architecture-doc/issues) -- **✉️ Contact**: [leverage@binbash.co](mailto:leverage@binbash.co) +- **Documentation**: [leverage.binbash.co](https://leverage.binbash.co) +- **Community**: [GitHub Discussions](https://github.com/binbashar/leverage/discussions) +- **Issues**: [Report bugs or request features](https://github.com/binbashar/le-ref-architecture-doc/issues) +- **Contact**: [leverage@binbash.co](mailto:leverage@binbash.co) ## 📄 License From 4be167699b7015e6320e145e21b0fd0e52470c4d Mon Sep 17 00:00:00 2001 From: exequielrafaela Date: Wed, 27 Aug 2025 12:09:17 -0300 Subject: [PATCH 07/13] adjusting cursor rule ICP reference --- .cursor/rules/doc-binbash-leverage.mdc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.cursor/rules/doc-binbash-leverage.mdc b/.cursor/rules/doc-binbash-leverage.mdc index 8503021bc..d1c7aeb21 100644 --- a/.cursor/rules/doc-binbash-leverage.mdc +++ b/.cursor/rules/doc-binbash-leverage.mdc @@ -6,7 +6,7 @@ alwaysApply: true # Binbash Leverage Reference Architecture - Documentation Assistant -You are an AI assistant specialized in binbash Leverage, an enterprise-grade AWS infrastructure-as-code ecosystem that accelerates cloud deployment by up to 10x. You help users with documentation, implementation, architecture decisions, and best practices. +You are an AI assistant specialized in binbash Leverage, a production-ready AWS infrastructure-as-code ecosystem designed for startups in regulated industries (Fintech, HealthCare, and Life Sciences, among others) that accelerates cloud deployment by up to 10x. You help users with documentation, implementation, architecture decisions, and best practices. ## Core Understanding From 65ce7a880c475cc926e171a1fbb3caefdd128cbc Mon Sep 17 00:00:00 2001 From: exequielrafaela Date: Wed, 27 Aug 2025 12:31:43 -0300 Subject: [PATCH 08/13] fix: Address CodeRabbit AI suggestions - Fix duplicate 'to to' in CONTRIBUTING.md line 289 - Correct numbered list sequencing in docs/work-with-us/contribute.md (1,2,3 instead of 1,3,4) - Fix nested code blocks formatting in CONTRIBUTING.md using quadruple fence Resolves all CodeRabbit AI review comments from PR #249 --- CONTRIBUTING.md | 6 +++--- docs/work-with-us/contribute.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 90e7d43f9..68fec8918 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -121,7 +121,7 @@ This repository contains the source code for the [Leverage documentation website ``` #### Code Blocks -```markdown +````markdown # For shell commands ```bash leverage aws configure @@ -138,7 +138,7 @@ resource "aws_instance" "example" { ami = "ami-12345678" } ``` -``` +```` #### Links and References ```markdown @@ -286,7 +286,7 @@ We appreciate all contributions to the documentation: ### Complementary Contributing Guide -For detailed information about contributing to to Other Leverage Framework Projects +For detailed information about contributing to other Leverage Framework projects inside our ecosystem (not just documentation), see our comprehensive [Contributing Guide](https://leverage.binbash.co/work-with-us/contributing/). --- diff --git a/docs/work-with-us/contribute.md b/docs/work-with-us/contribute.md index a38e80c30..a2b830537 100644 --- a/docs/work-with-us/contribute.md +++ b/docs/work-with-us/contribute.md @@ -66,8 +66,8 @@ Each repository has setup instructions in its README file. Need assistance? Here's how to get help: 1. **Check existing documentation** and GitHub issues -3. **Report issues** in this repository -4. **Email support**: [leverage@binbash.co](mailto:leverage@binbash.co) +2. **Report issues** in this repository +3. **Email support**: [leverage@binbash.co](mailto:leverage@binbash.co) --- From 96026f8ba4eae5e588af341645d5408cd2c4f827 Mon Sep 17 00:00:00 2001 From: exequielrafaela Date: Wed, 27 Aug 2025 12:38:34 -0300 Subject: [PATCH 09/13] fix: Resolve additional CodeRabbit AI suggestions in cursor rule - Add missing Content Guidelines section - Fix references to use 'this rule file' instead of invalid .cursorrules references - Complete the cursor rule with proper documentation approach guidelines - Ensure consistency with .mdc format and technical context Addresses CodeRabbit AI comments from PR #249 --- .cursor/rules/doc-binbash-leverage.mdc | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/.cursor/rules/doc-binbash-leverage.mdc b/.cursor/rules/doc-binbash-leverage.mdc index d1c7aeb21..7a489ad3c 100644 --- a/.cursor/rules/doc-binbash-leverage.mdc +++ b/.cursor/rules/doc-binbash-leverage.mdc @@ -158,4 +158,16 @@ project/ 5. **Operational Excellence**: Implement monitoring, automation, and best practices 6. **Reliability**: Design for high availability and disaster recovery -Use this knowledge to provide accurate, actionable guidance for implementing and managing AWS infrastructure with the Leverage ecosystem. \ No newline at end of file +Use this knowledge to provide accurate, actionable guidance for implementing and managing AWS infrastructure with the Leverage ecosystem. + +## Content Guidelines + +### **Documentation Approach** +- Follow binbash Leverage terminology and architectural concepts as defined in this rule file +- Maintain consistency with existing documentation structure and navigation +- Reference the comprehensive knowledge base in this file for accurate technical details +- Always consider the multi-account, multi-layer context when making recommendations + +### **Technical Context** +- **Multi-layered Architecture**: Network, Security, Shared, and Apps layers with clear separation of concerns +- **Multi-account Strategy**: Management, Security, Shared, and Application accounts with AWS Organizations \ No newline at end of file From 98c918bff68dc022a234ab661e348dbaeb4ee59e Mon Sep 17 00:00:00 2001 From: exequielrafaela Date: Wed, 27 Aug 2025 12:40:22 -0300 Subject: [PATCH 10/13] fix: Update CLAUDE.md to reference correct cursor rule path - Fix broken references from .cursorrules to .cursor/rules/doc-binbash-leverage.mdc - Update all 4 occurrences (lines 50, 78, 117, 119) to point to the correct path - Ensure AI assistants and contributors find the right cursor rule file - Maintain consistency with modern cursor rule format and location Resolves CodeRabbit AI suggestion about broken .cursorrules references --- CLAUDE.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index a21d42f85..1b1030351 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -47,7 +47,7 @@ make release-{major|minor|patch} # Create releases ### Configuration Files - `mkdocs.yml` - Complete MkDocs configuration with navigation structure - `Makefile` - Build automation entry point -- `.cursorrules` - AI assistant guidelines for binbash Leverage ecosystem +- `.cursor/rules/doc-binbash-leverage.mdc` - AI assistant guidelines for the Leverage documentation ecosystem ## Content Organization @@ -75,7 +75,7 @@ The documentation follows a structured approach: - Follow existing content structure and navigation defined in `mkdocs.yml` - Place images in `docs/assets/images/` with appropriate subdirectories - Use DrawIO for editable diagrams, store sources in `docs/assets/diagrams/editable/` -- Follow binbash Leverage terminology and concepts as defined in `.cursorrules` +- Follow binbash Leverage terminology and concepts as defined in `.cursor/rules/doc-binbash-leverage.mdc` ### Deployment Process - **Branches**: `master` for source, `gh-pages` for deployed site @@ -114,7 +114,7 @@ This documentation covers the **binbash Leverage™** ecosystem - an enterprise- - **Multi-account Strategy**: Management, Security, Shared, and Application accounts with AWS Organizations ### Content Guidelines -- Follow binbash Leverage terminology and architectural concepts as defined in `.cursorrules` +- Follow binbash Leverage terminology and architectural concepts as defined in `.cursor/rules/doc-binbash-leverage.mdc` - Maintain consistency with existing documentation structure and navigation -- Reference the comprehensive knowledge base in `.cursorrules` for accurate technical details +- Reference the comprehensive knowledge base in `.cursor/rules/doc-binbash-leverage.mdc` for accurate technical details - Always consider the multi-account, multi-layer context when making recommendations \ No newline at end of file From 27496a16aa723c989b7c1e6dfd92a6abf93153b7 Mon Sep 17 00:00:00 2001 From: Exequiel Barrirero Date: Wed, 27 Aug 2025 13:41:23 -0300 Subject: [PATCH 11/13] Apply suggestion from @coderabbitai[bot] Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- docs/work-with-us/contribute.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/work-with-us/contribute.md b/docs/work-with-us/contribute.md index a38e80c30..6c5ead696 100644 --- a/docs/work-with-us/contribute.md +++ b/docs/work-with-us/contribute.md @@ -66,9 +66,8 @@ Each repository has setup instructions in its README file. Need assistance? Here's how to get help: 1. **Check existing documentation** and GitHub issues -3. **Report issues** in this repository -4. **Email support**: [leverage@binbash.co](mailto:leverage@binbash.co) - +2. **Report issues** in this repository +3. **Email support**: [leverage@binbash.co](mailto:leverage@binbash.co) --- **Thank you for contributing to binbash Leverage!** Your contributions help make cloud infrastructure more accessible and reliable for everyone! 🚀 \ No newline at end of file From 50251a8ce6cace3a778a2cb0f16ffa84c970c995 Mon Sep 17 00:00:00 2001 From: exequielrafaela Date: Wed, 27 Aug 2025 14:01:07 -0300 Subject: [PATCH 12/13] commiting coderabbitai suggestions --- docs/work-with-us/contribute.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/work-with-us/contribute.md b/docs/work-with-us/contribute.md index a2b830537..20da3bb16 100644 --- a/docs/work-with-us/contribute.md +++ b/docs/work-with-us/contribute.md @@ -30,8 +30,8 @@ Thank you for your interest in contributing to **binbash Leverage**! This guide ```bash git clone https://github.com/YOUR_USERNAME/le-ref-architecture-doc.git cd le-ref-architecture-doc - make init-makefiles # First time only - make docs-live # Visit http://localhost:8000 + make init-makefiles # Required: downloads external makefiles + make docs-live # Start dev server at http://localhost:8000 ``` ### For Other Project Contributions From ac3f02ca78a0d174c2fed54b6134d59fdf434d96 Mon Sep 17 00:00:00 2001 From: exequielrafaela Date: Wed, 27 Aug 2025 14:06:24 -0300 Subject: [PATCH 13/13] cursor rule improvement --- .cursor/rules/doc-binbash-leverage.mdc | 1 + 1 file changed, 1 insertion(+) diff --git a/.cursor/rules/doc-binbash-leverage.mdc b/.cursor/rules/doc-binbash-leverage.mdc index 7a489ad3c..2086ee7a9 100644 --- a/.cursor/rules/doc-binbash-leverage.mdc +++ b/.cursor/rules/doc-binbash-leverage.mdc @@ -160,6 +160,7 @@ project/ Use this knowledge to provide accurate, actionable guidance for implementing and managing AWS infrastructure with the Leverage ecosystem. + ## Content Guidelines ### **Documentation Approach**