Difference between revisions of "HZW Documentation"

From hzw wiki
Jump to navigation Jump to search
Line 1: Line 1:
[[File:Nothingtosee.gif|thumb]]
+
[[File:Doku2.jpg|alt=|thumb|Documentation. Lots of documentation.]]
doku goes here
+
The documentation of all things HZW has the following philosophy:
 +
 
 +
# General information, processes, methods and how-to's get documented in this [https://wiki.kabelsalat.it/ Wiki]
 +
# Physical and Logical Resources like Servers, IPs, Networks, Services, VLANs etc. get documented in [https://netbox.kabelsalat.it Netbox]
 +
# Projects and changes get tracked using [https://kb.kabelsalat.it/ Kanboard]
 +
 
 +
 
 +
== Organizational Documentation ==
 +
 
 +
=== Chat ===
 +
Our primary tool for communication and coordination is [https://matrix.org/ matrix].
 +
 
 +
To join our matrix server '''matrix.kabelsalat.it''' you need a matrix client like [https://matrix.org/docs/projects/client/riot riot].
 +
 
 +
We will provide you with login credentials.
 +
<br />
 +
 
 +
=== Video Conferences ===
 +
For means of faster communication and collaborative working we use our
 +
 
 +
We will provide you with login credentials.
 +
 
 +
 
 +
== Technical Documentation ==
 +
 
 +
 
 +
Our Root Server - Info's on the structure that all this runs on
 +
 
 +
Network - All things related to the hypervisor side of the network
 +
 
 +
Virtual Machines - Do's and dont's for VMs running at HZW
 +
<br />
 +
 
 +
== Guides ==
 +
Guide to documenting with Mediawiki
 +
 
 +
Guide to documenting with Kanboard
 +
 
 +
Guide to documenting with Netbox
 +
<br />

Revision as of 13:21, 14 May 2020

Documentation. Lots of documentation.

The documentation of all things HZW has the following philosophy:

  1. General information, processes, methods and how-to's get documented in this Wiki
  2. Physical and Logical Resources like Servers, IPs, Networks, Services, VLANs etc. get documented in Netbox
  3. Projects and changes get tracked using Kanboard


Organizational Documentation

Chat

Our primary tool for communication and coordination is matrix.

To join our matrix server matrix.kabelsalat.it you need a matrix client like riot.

We will provide you with login credentials.

Video Conferences

For means of faster communication and collaborative working we use our

We will provide you with login credentials.


Technical Documentation

Our Root Server - Info's on the structure that all this runs on

Network - All things related to the hypervisor side of the network

Virtual Machines - Do's and dont's for VMs running at HZW

Guides

Guide to documenting with Mediawiki

Guide to documenting with Kanboard

Guide to documenting with Netbox