Skip to content

Latest commit

 

History

History
68 lines (55 loc) · 3.72 KB

CONTRIBUTING.md

File metadata and controls

68 lines (55 loc) · 3.72 KB
Raw

How to contribute to CTF Handbooks

Making Changes to the Handbooks

Structure of the Writerside Folder

./Writerside/
├───cfg/
│   ├───buildprofiles.xml
├───images/
│   ├───air.png
│   ├───appenditemname.png
│   ├───...
├───topics/
│   ├───Commonly-Used-Itemstrings-List.md
│   ├───Making-a-Map-for-Capture-the-Flag.md
│   └───...
├───c.list
├───ch.tree
├───v.list
└───writerside.cfg

The main folders you would need to know are the images and topics sub-folders within the Writerside folder.

  • images: This folder contains all the image media used in the handbook. When adding new images, place them in this folder.
  • topics: This folder is the home to all the Handbook markdown files. When adding new chapters without using Writerside, make new markdown files for them here.

The below sections will introduce you to the two ways in which you can make changes to the content of handbooks: (1) Using Writerside and (2) Without using Writerside.

Using Writerside

  1. Install the latest version of JetBrains Writerside OR the Writerside IDE Plugin on a compatible JetBrains IDE.
  2. Fork this repository and clone your forked repository on your local machine.
  3. Then, open the cloned repository in the Writerside application or a JetBrains IDE equipped with the Writerside Plugin.
  4. Now you can make your changes. Read the Writerside documentation to learn how to use it.
  5. Submit your changes

Without using Writerside

Although it is not recommended to make changes without using Writerside, it should still be possible.You may add new topics or modify existing ones. Modifying is simple enough, but you will have to go through a few steps for adding new topics.

Adding new topics:

  1. Taking "Foo Bar Test" as a topic name, you will have to first create a .md file in the topics folder as Foo-Bar-Test.md with the following contents: 
    # Foo Bar Test

(add your contents here...)
  2. If you were to add the topic using Writerside, it would automatically modify the contents of ch.tree when adding the new topic. Here though, you'll have to add them manually. Please take note of the structure of topics and sub-topics as well to prevent any errors. For example:
(...)

<instance-profile id="ch"
                 name="CTF Handbooks"
                 start-page="starter-topic.md">

    <toc-element topic="Foo-Bar-Test.md"/>
    <toc-element topic="starter-topic.md"/>
    (...)
    <toc-element topic="Troubleshooting.md"/>
</instance-profile>

After making your changes, you may submit your changes.

Submitting Changes

Please make a GitHub Pull Request to ctf-handbooks.github.io with a clear description of your changes if not explicitly mentioned through the title. Read more about Pull Requests here.