This repository hosts the website of the Archive of Awesome and Dark Tactics.
Hi! These are instructions for the maintainer of the archive.
- Rename the image file appropriately to match the tactic it belongs to, and place the image file into the
docs/assets/diagrams
folder. In the markdown file of the corresponding tactic, copy the following line belowt-source-doi
but before---
. Replace the nameimage
with the correct filename of the model.t-diagram: "image.png"
- Commit the changes to the repository.
- If you want to create a new tactic for the archive, first follow the instructions on the "Contributions" page of the website. If you have followed the instructions or received a tactic from someone who wants to contribute, continue with the next step.
- Rename the markdown file (ending in
.md
) to:YYYY-MM-DD-title.md
whereYYYY-MM-DD
specifies today's date (this will not be displayed in the archive, but is required by Jekyll to process the file) andtitle
being the name of the tactic. The title may contain underscores for readability. - If a model (ending in
.png
) was submitted alongside the tactic, rename the image file appropriately to match the tactic, and place the image file into thedocs/assets/diagrams
folder. In the markdown file of the corresponding tactic, copy the line belowt-source-doi
but before---
. Replace the nameimage
with the correct filename of the model.t-diagram: "image.png"
- Place the markdown file into the
docs/_posts
folder. - Commit the changes to the repository.
- The tactic should be shown in the archive.
If the tactic uses a category or tags that were not previously used in the archive, additional files need to be added.
- Duplicate an existing file from the
docs/categories
folder. Rename the file according to the new category (keep the extension.md
), and fill in the following fields inside the markdown file:category-name
category-description
category-type
- Place the file into the
docs/categories
folder. - Commit the changes to the repository.
- The category should be shown on the Catalog page of the archive.
- Duplicate an existing tag file from the
docs/tags
folder. Rename the file according to the new tag, and fill in the following field inside the markdown file:tag-name
- Place the file into the
docs/tags
folder. - Commit the changes to the repository.
- The tag should be shown on the Tag Selection page of the archive.