-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update documentation to include structure of the file system. Also co…
…rrect some of the testing info.
- Loading branch information
Seonaid
committed
Jun 30, 2021
1 parent
d90432a
commit 882d2f4
Showing
6 changed files
with
52 additions
and
55 deletions.
There are no files selected for viewing
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
--- | ||
title: Structure of the Drumkit Project | ||
|
||
--- | ||
|
||
|
||
Drumkit contains three kinds of make files in the `mk` directory: | ||
[ note: we need to distinguish between `mk` and `.mk` in the documentation] | ||
- Projects | ||
- Tasks | ||
- Tools | ||
|
||
## Projects | ||
|
||
You can use drumkit to initialize the following types of projects: | ||
- Ansible (creates the following components) | ||
- Inventory | ||
- Groups | ||
- Hosts | ||
- Packer | ||
- Drupal | ||
- Hugo docs sites | ||
- Aegir | ||
- Openstack | ||
- Aegir VPS | ||
|
||
|
||
## Tasks | ||
|
||
The "tasks" category is for ongoing building and maintenance tasks that have been automated with drumkit. | ||
|
||
This includes: | ||
- Running the docs server (`make docs-start` and `make docs-kill`) | ||
- Managing git submodules | ||
- Running drumkit tests (`make test-drumkit`) | ||
- Running ansible playbooks | ||
|
||
## Tools | ||
|
||
This set of files is primarily for the installation of new tooling software. If it's a noun, it's probably in the "Tools" category. This is an evolving list, so check the `mk/tools` folder for the lastest options. | ||
|
||
Some examples include: | ||
- Hugo | ||
- Gitlab-runner | ||
- Lando (only on Linux - must be installed manually for OSX) | ||
- Packer | ||
- Terraform |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters