Brainboard's documentation
Go to the app ↗
  • Welcome
  • Getting started
    • Fast track
    • Start with a template
    • Start with AI
    • Use cases videos
    • Brainboard philosophy
  • Cloud design
    • Left bar
      • Cloud resources
      • Input & output
    • Design area
      • Node
      • ID card
      • Connectors
      • Versioning
      • Graphical options
    • One action
    • Code Edition
  • Data
    • Data structure
      • Project
      • Environment
      • Cloud architecture
        • Terraform files
        • Readme file
        • Architecture Synchronization
        • Remote backend
      • Template
    • Cloud providers
      • Supported cloud providers
      • Customize provider configuration
      • Unsupported cloud providers
    • Terraform / OpenTofu
      • Modules
        • Module
        • Import modules
        • Manage module
        • Terraform registry credentials
        • Use modules
    • Disaster recovery
  • Automation
    • CI/CD engine
    • Supported plugins
      • Terraform
      • Security
        • Trivy
        • Tfsec
        • Terrascan
        • OPA
        • Checkov
      • Infracost
      • Notifications
        • Email
        • Slack
        • Microsoft Teams
      • Webhooks
    • Pipelines
    • Workflow templates
    • Drift detection
      • Types of drift
      • Remediation
    • Self-Hosted Runner
      • Deploy runner with Kubernetes
      • Deploy runner with docker-compose
  • Settings
    • Overview
    • Authentication
      • Login into Brainboard
      • Single sign-on (SSO)
    • Account management
    • Organization
    • Members
    • Teams
    • Roles & Permissions (RBAC)
      • Level of access
      • Organization RBAC
      • Project RBAC
    • Integrations
      • Git configuration
        • GitHub
        • Azure DevOps (ADO)
        • Bitbucket
        • GitLab
        • How to use
      • Cloud providers
        • AWS
        • Azure
        • GCP
        • OCI
  • Security
    • Data managed by Brainboard
    • SOC 2 Type II
    • Role Based Access Control
  • Help & FAQ
    • Shortcuts
    • FAQ
    • Migration
      • Import from cloud provider
    • Support
    • Glossary
  • Changelog
Powered by GitBook
On this page
  • Description
  • Edit README file
  • Visibility of the README file
  • Best practice

Was this helpful?

Edit on GitHub
  1. Data
  2. Data structure
  3. Cloud architecture

Readme file

PreviousTerraform filesNextArchitecture Synchronization

Last updated 8 months ago

Was this helpful?

Description

The readme file refers to a text file that provides information about the architecture, its features, requirements, installation instructions, and usage instructions.

It's an important component as it serves as the first point of reference for users.

To add a README file to your architecture, click on the file icon placed at the end of the design area options bar:

Edit README file

To add information and edit the README file, just open the editor and add the details.

Brainboard gives you the possibility to write Markdown document and generates the HTML representation for it, which makes it super easier to read for you and your team.

Visibility of the README file

  • The README file will be displayed on the templates catalog

  • The README file will be pushed to git when doing a pull request.

  • The README file will be cloned along with the design of your architecture.

Best practice

A good README file typically includes the following information:

  • Project description: A brief overview of the architecture, its purpose, and its key features.

  • Usage instructions: A step-by-step guide on how to use the architecture, including any variables and configuration settings.

  • Support and contact information: Details on how to get support or contact the development team, such as through email, forums, or social media.

  • Release notes: A list of changes, bug fixes, and new features for each release of the architecture.

Read me
Read me configuration