Skip to content

Latest commit

 

History

History
64 lines (44 loc) · 3.14 KB

CONTRIBUTING.md

File metadata and controls

64 lines (44 loc) · 3.14 KB
Raw

Contributing

This is the documentation for contributing to an individual wiki. Please create an issue for any unclear or missing information. Documentation for contributing to the theme repository is a WIP.

Basic contributing

To start contributing, fork the repository and make your changes. After you are done making your changes submit a pull request to the main repository with an explanation of your changes. For any help, please create an issue.

Editing Content

To edit existing content in a wiki, navigate to the page you would like to edit on the website. Look at the URL and match that to the directory structure of the repo.

Example

If you want to edit https://sqlwiki.netspi.com/attackQueries/persistence, you would navigate to https://github.com/[YOUR_USERNAME]/SQLInjectionWiki/attackQueries/persistence.html and make your changes in that file. If you are having trouble finding a file try searching a few words from that page in the Github search bar.

Development

If you would like to do heavier development and need a local version for testing, follow the instructions here.

Style

Follow the styles already set in the existing files if not listed below.

  • All code snippets should be wrapped in <code></code>
  • All top headers should be <h3></h3>
  • All sub section headers should be <h4 class="subheading"></h4>
  • Top level descriptions should be <p class="readableText"></p>
  • Secondary descriptions should just be <p></p>
  • All external links should be <a target="_blank" rel="noopener" href="[link]"></a>

Section Types

There are only 3 types of sections allowed through our navigation style.

  • Clickable sections
  • Clickable sections with children
  • Non-clickable sections with children

Non-clickable sections are typically used as a title header for their children, when the children grouping don't need a description (i.e. "Miscellanious"). Clickable sections with children typically utilize the clickable section as a place to give an overview of the children.

Adding a new section

To add a new section or child place it in the appropriate location.

Clickable sections w/ children:

  • /sectionName/index.html #For the clickable section
  • /sectionName/childName.html #For each child

Clickable sections w/o children:

  • /sectionName.html #For the clickable sectoin

Non-clickable sections:

  • /sectionName/childName.html #For each child

After adding a new section, modify the _data/nav.yml file and add the section in its proper place. There should only be 3 navigation types as stated in Section Types.

URL Path Rules

When referencing a page through an href or other link tag use the following guidelines. Pay close attention to the existence or lack of a trailing backslash:

Clickable sections w/ children:

  • For the section link use /sectionName/
  • For the children links use /sectionName/childName

Clickable sections w/o children:

  • /sectionName

Non-clickable sections:

  • /sectionName/childName