Skip to content

Instantly share code, notes, and snippets.

@janikvonrotz
Last active January 17, 2021 16:19
Show Gist options
  • Save janikvonrotz/a9eeb4d5ae551073fda8b5d3743b2cfc to your computer and use it in GitHub Desktop.
Save janikvonrotz/a9eeb4d5ae551073fda8b5d3743b2cfc to your computer and use it in GitHub Desktop.
#Markdown
title author
Readme
Janik von Rotz

Knowledge

Logo

The knoweldge articles are stored in a strict structure. There are 7 top level folders:

1. Infrastructure

Hardware, networking and operating system and client configuration.

Substructure: Infrastructure/_DEVICE_TYPE_/_COMPANY_NAME_/_PRODUCT_NAME_/_VERSION_

Examples:

  • Infrastructure/Laptop/Hewlett Packard/Probook 450/Bios Update durchführen.md
  • Infrastructure/Windows Client/Windows 8/Speerbildschirm mit lokalem Benutzer deaktivieren.md

2. Services

Internal services.

Substructure: Services/_CATEGORY_/_PRODUCT_NAME_/_VERSION_

Examples:

  • Services/Webapps/Exchange Webmail/2016/Set timezone in Webmail.md

3. External Services

Documentations of external dependencies.

Substructure: External Services/_COMPANY_NAME_/_PRODUCT_NAME_

Examples:

  • External Services/United Planet/Intreex/Contact.md

4. Applications

Customer instructions and installation documentations of client applications.

Substructure: Applications/_COMPANY_NAME_/_APPLICATION_NAME_/_VERSION_

Examples:

  • Applications/Microsoft/Outlook/2016/Add shared mailbox to Outlook.md

5. Administration

IT Management documentations.

Substructure: Administration/_PROCESS_/_SUB_PROCESS_

Example:

  • Administration/Finance/External Services/Accounting.md

6. Projects

IT project documentations.

Substructure: Projects/_PROJECT_NAME_/_PROCESS_

Examples:

  • Project/PolyPoint PEP/Konzept/Stakeholder.md

7. Products

Company owned products.

Substructure: Products/_PRODUCT_NAME_/_SUBPROUDCT_

Examples:

  • nevis/Keybox/Commands.md

Home

This is an optional folder. Space for personal notes.

Substructure: Substructure: Home/_USERNAME_

Examples:

  • Substructure: Home/janik/Mail Signature.md

assets

Store images, gifs, pdfs and other files in this folder.

Markdown

*.md files are simple text files. They can be edited using an kind of text editor. The file extension means Markdown. Markup is a popular markup language. Markdown can be transpiled to HTML. There are a lot of editors to edit and view Markdown files.

Diagrams

Use asciiflow to create beautiful diagrams.

+-----+     +-----+
|     |     |     |
|  A  +----->  B  |
|     |     |     |
+-----+     +-----+
title status author
Template
draft|published|deprecated
Janik von Rotz

Lorem Ipusm

Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo. Quisque sit amet est et sapien ullamcorper pharetra. Vestibulum erat wisi, condimentum sed, commodo vitae, ornare sit amet, wisi. Aenean fermentum, elit eget tincidunt condimentum, eros ipsum rutrum orci, sagittis tempus lacus enim ac dui. Donec non enim in turpis pulvinar facilisis. Ut felis. Praesent dapibus, neque id cursus faucibus, tortor neque egestas augue, eu vulputate magna eros eu erat. Aliquam erat volutpat. Nam dui mi, tincidunt quis, accumsan porttitor, facilisis luctus, metus

PROBLEM

CAUSE

SOLUTION

FIX

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment