Difference between revisions of "HZW Documentation"

From hzw wiki
Jump to navigation Jump to search
(Added more Infos on how we organize)
(Finalized first draft of the Organisational HZW Documentation)
Line 15: Line 15:
  
 
On this Matrix server, there is the "'''hzw admins'''" channel.
 
On this Matrix server, there is the "'''hzw admins'''" channel.
[[File:Riothzw.png|left|frameless]]
 
 
 
 
 
 
 
  
 +
[[File:Riothzw.png|alt=|frameless]]
  
  
Line 38: Line 32:
 
There are no regular hzw meetings. We get together when the need arises.
 
There are no regular hzw meetings. We get together when the need arises.
  
=== Coordinate projects ===
+
<br />
Please open a Ticket in our Kanban Board "Team HZW"
+
 
 +
===Coordinate projects===
 +
We use kanboard to plan, coordinate and track almost all of our activities.
 +
 
 +
 
 +
[[File:Kanboard.png|frameless]]
 +
 
 +
 
 +
Please open a ticket in our Kanban Board "team_hzw" if you want to:
  
If you want to report a bug, request a change or think I would be cool to have $thing but don't want to spend time implementing it or don't know how to
+
* report a bug
 +
* request a change
 +
* think I would be cool to have $thing (even if you don't want to spend time implementing it or don't know how to do it)
  
  

Revision as of 14:59, 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.

On this Matrix server, there is the "hzw admins" channel.


Plase report there and ask if it's ok If you make changes that have an impact.

Example:

"Hey guys, did $Something at the Database server. Can I reboot it to test it's reboot persistency?"

Answer: "No! $Important-thingy does $important-thing and cannot be disrupted right now! Wait one more hour please!"


Video Conferences

For means of faster communication and collaborative working we use our video conferencing solutions, if needed.

There are no regular hzw meetings. We get together when the need arises.


Coordinate projects

We use kanboard to plan, coordinate and track almost all of our activities.


Kanboard.png


Please open a ticket in our Kanban Board "team_hzw" if you want to:

  • report a bug
  • request a change
  • think I would be cool to have $thing (even if you don't want to spend time implementing it or don't know how to do it)


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