Contribute#

Hey There! Looks like you are here for contributing to the wiki…Let me help you with a few pointers!

  • The aim of this open-source project to create a central repository for all the cybersecurity content, which can be consumed by security researchers and newbies in the field.
  • You can add content related to any field and this is also a great place to showcase the content you have created.
  • The scope of the project is whatever you think can help out folks get started in the cyber security.
  • We have hosted everything on to Github, click on the button and it will take you to Github
    Contribute

Structure#

The structure is required for uniformity, so here are a few template, to help you curate the content.

The `_index.md` file acts as the index for that specific directory.
To add a new category
A category is the high level overview. For example - "**Application Security**" is a category. Steps - Create a new directory in docs directory. Add a new file inside the newly created directory called **_index.md** with the following content in it. ```markdown --- title: bookCollapseSection: true --- ``` a new category will be created. Each **Category will contain an `images/` folder.** Directory Structure - ``` content/ ├─ docs/ │ ├─ category-name/ │ │ ├─ images/ │ │ ├─ _index.md ```

Create a New Sub Category
To create a sub category in side a category, we need to create a directory inside the main category, which will contain all the different markdown files of different content. ```markdown --- title: bookCollapseSection: true --- ```

To add a new page
Each page will contain the following content - ```markdown --- title: --- ``` Images can be used in each page by using the complete link - `content/docs//images/.` Example - ```markdown ![Alt text](content/docs/cloud-security/images/image.png) ```

Infrastructure#

The wiki is built on the Hugo. If you can help with any improvements, feature additions, etc. You can create an Issue and we can discuss it over there.

Additional Features#

Linking an Internal Document
```tpl {{ " */> }} ``` It will help hugo internally process the document easily.

Other cool elements to be added can be found in the shortcode section.

Test Locally#

  1. Clone the repository to make changes locally -

    git clone [email protected]:payatu/cybersec-wiki.git
git submodule init
git submodule update

  2. Install Hugo Extended Latest Version.

  3. From the parent location of repository where the source code is, run

    hugo server

    It will start a local server to test the changes that you have made, in terms of look, feel and content.

  4. Once satisfied with the changes made, push the changes to GitHub, it will ask you to create a fork of the repository and make changes there.

  5. Create a Pull Request and if everything looks fine, the payatu team will be merging the content to the Cyber Security Wiki.