Difference between revisions of "HZW Documentation"
(Added more Infos on how we organize) |
|||
Line 2: | Line 2: | ||
The documentation of all things HZW has the following philosophy: | 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] | + | #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] | + | #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] | + | #Projects and changes get tracked using [https://kb.kabelsalat.it/ Kanboard] |
− | == Organizational Documentation == | + | ==Organizational Documentation== |
− | === Chat === | + | ===Chat=== |
Our primary tool for communication and coordination is [https://matrix.org/ matrix]. | 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]. | To join our matrix server '''matrix.kabelsalat.it''' you need a matrix client like [https://matrix.org/docs/projects/client/riot riot]. | ||
− | + | On this Matrix server, there is the "'''hzw admins'''" channel. | |
− | <br /> | + | [[File:Riothzw.png|left|frameless]] |
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | Plase '''<u>report</u>''' there '''<u>and ask if</u>''' it's '''<u>ok If</u>''' you make changes that have an '''<u>impact</u>'''. | ||
+ | |||
+ | Example: <blockquote>"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!" | ||
+ | |||
+ | <br /></blockquote> | ||
+ | |||
+ | ===Video Conferences=== | ||
+ | For means of faster communication and collaborative working we use our [https://wiki.kabelsalat.it/index.php?title=HZW_Services#Video_Conferencing video conferencing solutions], if needed. | ||
+ | |||
+ | There are no regular hzw meetings. We get together when the need arises. | ||
− | === | + | === Coordinate projects === |
− | + | Please open a Ticket in our Kanban Board "Team HZW" | |
− | + | 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 | |
− | == Technical Documentation == | + | ==Technical Documentation== |
Line 33: | Line 54: | ||
<br /> | <br /> | ||
− | == Guides == | + | ==Guides== |
Guide to documenting with Mediawiki | Guide to documenting with Mediawiki | ||
Revision as of 15:49, 14 May 2020
The documentation of all things HZW has the following philosophy:
- General information, processes, methods and how-to's get documented in this Wiki
- Physical and Logical Resources like Servers, IPs, Networks, Services, VLANs etc. get documented in Netbox
- Projects and changes get tracked using Kanboard
Contents
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
Please open a Ticket in our Kanban Board "Team HZW"
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
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