Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Provide documentation #4

Open
57 tasks
brunurd opened this issue Nov 17, 2022 · 0 comments
Open
57 tasks

Provide documentation #4

brunurd opened this issue Nov 17, 2022 · 0 comments
Assignees
@brunurd
Labels
documentation Improvements or additions to documentation

Comments

@brunurd
Copy link
Member

brunurd commented Nov 17, 2022 •
edited
Loading

Should add documentation inside this project with deploy and release setup for the static page.

Dmark docs by topic:

  • Overview
    • Why Dmark?
      • local state management
      • handling multiple config files
      • DRY and multi-stage management
      • managing no HCP projects
      • Terragrunt (compare solutions)
  • Dmark CLI
    • Dmark and Terraform commands
    • Dmark CLI parameters
      • config
      • stage
      • stack
      • label
      • fmt
      • upgrade
      • migrate-state
      • auto-approve
      • no-init
      • delete-lock
  • Stack
    • What is a stack?
  • Stage
    • What is a stage?
    • The __all__ stage
    • Ignoring stages
    • Stageless project
  • Local state management
    • Local property
      • boolean
      • with path
    • Multiple stages for the same local stack
  • Remote state management
    • How to setup a remote stack
      • general
      • AWS S3
  • Order
    • Managing deploy order
  • Labels
    • Labeling the stacks
  • Errors handling
    • Deploy error handling by Dmark
  • Dmark source code
    • Dmark license
    • Dmark maintainers
    • Dmark brand
    • Node.js, npm and pnpm motivations
    • How to setup the development environment
    • How to contribute
      • issues
      • lint
      • unit tests and coverage
      • integration tests examples
      • CHANGELOG.md
      • Release process
      • documentation
      • PR
@brunurd brunurd added the documentation Improvements or additions to documentation label Nov 17, 2022
@brunurd brunurd self-assigned this Nov 17, 2022
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees

@brunurd brunurd

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@brunurd