Skip to content
Crowd-sourced article base for the Zoroark Knowledge Base (ZKB)
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_articles
aPTST
aTHLR
mS2QS
mS3QS
pMBPC
pMTP11
README.md

README.md

kb.zoroark.guru Knowledge Base (or KB for short)

This is the repository used on kb.zoroark.guru to provide information on everything EPITA, although it can contain information which others find interesting too.

ALL FILES IN THIS REPOSITORY ARE THEIR OWNERS'. THE LICENSES DEPEND ON THE FILE. OPINIONS PRESENT HERE ARE THEIR OWNERS'. EXTERNAL RESOURCES ARE USED EITHER WITH PERMISSION FROM THE AUTHOR OR WITHIN THE RIGHTS GRANTED BY THEIR LICENSE.

Guidelines for contribution

Adding files is done by adding an article to the _articles folder (follow mS2QS as an example of what a more or less complete file may look like as I do not have a full template ready right now), and all necessary content to the <id> folder at the root of this repository if you need to add downloadable files.

You must add the same id as the name of the .md file and in the articleid field. The first letter should be the first letter of the category, and the following characters should be short enough to identify the article. The ID must be short.

Files that need to be excluded from the website should start with an underscore _ (note that _articles). This README is also excluded from the website.

To add files: simply fork this repository, make the changes on your fork, and create a pull request. All files are accepted as long as the authors are clearly defined, are at least a little bit relevant to EPITA or to subjects taught at EPITA and that they do not break anyone's copyright.

If your submission is only a PDF file, and you don't want to spend time creating the article yourself, open an issue and we will add them ourselves.

Contribution outline

  • Clone this repository
  • Create a new article with in the _articles folder following the naming standards
  • Add all necessary resource files in the root of the directory in a folder with the articleID as its name.
  • Create a pull request, or create an issue if you want us to do the steps above for you (only for simple articles which are just PDFs).
You can’t perform that action at this time.