MKSP - How To Wiki

Herzlich willkommen auf dem Makerspace Darmstadt Wiki!

Diese Seite stellt ein paar Informationen insbesondere für diejenigen zusammen, die aktiv am Wiki arbeiten möchten. Das Wiki ist so gedacht, dass jedes Mitglied mitarbeiten kann. Das Wiki lebt von deiner Mitarbeit! Bitte beachte jedoch die unterstehenden Regeln und Best Practices.

4

5

**Fällt dir irgendwas auf, was falsch ist?** Korrigiere es gerne!

6

**Fehlt dir irgendwas?** Füge es gerne hinzu!

7

8

9

Fehlen dir auf dieser Seite irgendwelche Informationen, die Du brauchst, um am Wiki mitzuarbeiten? Hinterlasse einfach ein Kommentar unten, dann werden wir uns darum kümmern, deine Fragen möglichst zeitnah zu beantworten!

10

11

12

= {{id name="HowToWiki-Inhaltsverzeichnis"/}}Inhaltsverzeichnis =

= {{id name="HowToWiki-AufbaudesWikis"/}}Aufbau des Wikis =

17

18

== {{id name="HowToWiki-WikiÜbersicht"/}}Wiki Übersicht ==

19

20

Als Software des Wikis kommt eine Community-Version von [[Atlassian Confluence>>url:https://www.atlassian.com/software/confluence||shape="rect"]] zum Einsatz, die uns als Makerspace kostenfrei zur Verfügung gestellt werden.

21

22

== {{id name="HowToWiki-Spaces"/}}Spaces ==

23

24

Das Wiki ist in verschiedene so genannte Spaces eingeteilt, je einen für einen Werkstattbereich sowie einige interne Bereiche. Der Zugriff auf manche internen Bereiche ist geschützt. Übersicht:

25

26

(% class="wrapped" %)

|=(((

Bereich

)))|=(((

Spaces

)))|=(((

Wer darf Lesen

)))|=(((

Wer darf Schreiben

)))

|(((

Öffentlich

)))|(((

Alle Werkstätten, Projekte, Der Verein

40

)))|(((

41

Jeder (auch ohne Anmeldung)

)))|(((

Jedes Mitglied

)))

|(((

Intern

)))|(((

Intern

)))|(((

Jedes Mitglied

)))|(((

Jedes Mitglied

)))

|(((

Geschützt

)))|(((

Inner Circle

)))|(((

Vorstand + Bereichsleiter

60

)))|(((

61

Vorstand + Bereichsleiter

62

)))

63

64

== {{id name="HowToWiki-Pages"/}}Pages ==

65

66

Innerhalb der Spaces werden Seiten erstellt, die hierarchisch aufgebaut werden. Folgende Regeln gilt für die Seiten (Pages):

67

68

* Der Page-Name muss innerhalb eines Spaces eindeutig sein

69

* Der Page-Name darf keine Sonderzeichen enthalten

70

* Es darf innerhalb eines Spaces maximal 3 Level geben, darunter darf keine weitere Seite angelegt werden

71

* Es existieren zwei Templates ein allgemeines und eins für die Beschreibung von Maschinen. Letzteres ist beim Erstellen neuer Maschinen zu verwenden

72

73

Der Aufbau und die Struktur innerhalb eines Bereichs (Holz, Metall, Laser, ...) ist immer gleich und wird hier am Beispiel der Holzwerkstatt gezeigt:

Die Seiten sind:

* **Die Holzwerkstatt**: Bereichsübersicht, Fotos, Bereichsleiter, ... alles was den Bereich im allgemeinen Betrifft

80

* **Maschinen**: Eine Seite pro Maschine, die in diesem Bereich ist

81

* **Maschinen => Unterseite**: Unterhalb jeder Maschine können weitere Seiten mit Details oder Anleitungen bezüglich dieser speziellen Maschine angelegt werden. Als Beispiel könnte dort eine Anleitung erstellt werden, wie bei der Holz-CNC die Z-Achse korrekt eingestellt wird.

82

* **Kleinwerkzeuge**: Übersicht über alle Kleinwerkzeuge in diesem Bereich, die keine eigene Seite haben wie die Maschinen

83

* **Anleitungen**: Hier können Anleitungen angelegt werden, die einen Vorgang oder ein Verfahren maschinenunabhängig zu beschreiben

84

85

== {{id name="HowToWiki-WaskommtWohin?"/}}Was kommt Wohin? ==

86

87

Grundsätzlich gibt es verschiedene Arten von Inhalt, die an unterschiedlichen Stellen im Wiki ihren Platz haben. Die folgende Tabelle gibt eine Übersicht:

|=(((

Inhalt

)))|=(((

Wohin

)))

|(((

Organisatorische Informationen (Einweisungen, Verein, ...)

)))|(((

[[doc:MD.WebHome]]

)))

|(((

Sonstige organisatorische oder allgemeine Infos

)))|(((

[[doc:MD.WebHome]]

)))

|(((

Beschreibung eigener Projekte (kann gerne auf Anleitungen innerhalb der Bereiche verweisen)

106

)))|(((

107

[[doc:PROJ.WebHome]] > [[doc:PROJ.Mitgliederprojekte.WebHome]]

108

)))

109

|(((

110

Vereinsprojekte (Datron-Fräse, ...)

111

)))|(((

112

[[doc:PROJ.WebHome]] > [[doc:PROJ.WebHome]]

113

)))

114

|(((

115

Workshops und Inhalte

116

)))|(((

117

[[doc:PROJ.WebHome]] > Workshops

118

)))

119

|(((

120

Beschreibung einer Maschine

121

)))|(((

122

//Bereich// > Maschinen

123

)))

124

|(((

125

Anleitung oder Erklärung zu einer Maschine

126

)))|(((

127

//Bereich// > Maschinen > //Maschine//

128

)))

129

|(((

130

Allgemeine Anleitungen (Wie erstelle ich Joins bei 3D Druck Teilen?)

131

)))|(((

132

//Bereich// > Anleitungen

133

)))

134

|(((

135

Interne Inhalte, die nicht für die Öffentlichkeit bestimmt sind

)))|(((

[[doc:IN.WebHome]]

)))

= {{id name="HowToWiki-Maschinenvs.Kleinwerkzeuge"/}}Maschinen vs. Kleinwerkzeuge =

141

142

Wir unterscheiden zwischen **Maschinen** und **Kleinwerkzeuge**. **Maschinen** haben eine eigene Wiki-Seite direkt unterhalb der jeweiligen Werkstatt. Für **Kleinwerkzeuge** gibt es in jedem Werkstatt-Bereich eine eigene Seite für deren Beschreibung und Auflistung. //Für jedes Kleinwerkzeug ist hier eine "Heading 1" Überschrift zu wählen.//

143

144

Es gibt derzeit noch keine allgemeine Definition, was eine Maschine und was ein Kleinwerkzeug ist. Als Daumenregel: Wenn es sich lohnt, für irgendetwas eine eigene Wiki-Seite zu erstellen, dann kann es als Maschine angesehen werden.

145

146

= {{id name="HowToWiki-Linkserstellen"/}}Links erstellen =

147

148

[[image:attach:Link erstellen.png||thumbnail="true" data-xwiki-image-style-alignment="start" height="150"]]

149

150

Beim erstellen von Links zu Seiten im Wiki ist darauf zu achten, **dass nicht einfach die Adresszeile des Browsers kopiert wird**. Wird die Seite umbenannt, sind die Links nicht mehr gültig! Stattdessen sollte wie auf dem folgenden Screenshot zu sehen ein Link zur Seite generiert werden. Dieser ist kürzer und bleibt auch nach dem Umbenennen einer Seite konsistent.

\\

= {{id name="HowToWiki-Tags"/}}Tags =

155

156

Confluence verwendet Tags für die Organisation von Inhalten. So können beispielsweise automatisch Inhalte mit einem bestimmten Tag an einer anderen Stelle zusammengefasst werden. Folgende Tags werden aktuell verwendet:

157

158

(% class="wrapped" %)

|=(((

Tag

)))|=(((

Beschreibung

)))

|(((

(% class="content-wrapper" %)

(((

)))

)))|(((

Darf nur an Pages von Maschinen innerhalb eines Bereichs angefügt werden und bewirkt, dass die Maschine automatisch in der Geräteübersicht angezeigt wird.

171

)))

172

|(((

173

(% class="content-wrapper" %)

(((

)))

)))|(((

Bewirkt, dass eine Seite in den "Getting Started" Links auf der Startseite angezeigt wird

179

)))

180

|(((

181

(% class="content-wrapper" %)

182

(((

183

{{confluence_badge Style="dark" Text="anleitung-<maschinenkürzel>"/}}

184

)))

185

)))|(((

186

Für alle Seiten unterhalb einer Maschine - bewirkt, dass die Anleitung danach automatisch auf der Hauptseite der Maschine angezeigt wird

187

)))

188

189

= {{id name="HowToWiki-Lizenz"/}}Lizenz =

190

191

Um die kommerzielle Verwendung der hier erstellten Inhalte zu verhindern, wird der Inhalt unter die [[Creative Commons Attribution-NonCommercial-ShareAlike Lizenz>>url:https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode||shape="rect"]] gestellt. Durch deine Mitarbeit erkennst Du an, dass diese Lizenz auch für von dir veröffentliche Inhalte im Wiki gilt.

192

193

= {{id name="HowToWiki-Plugins"/}}Plugins =

194

195

Es sind einige Plugins in Verwendung, um die Features oder des Aussehen des Wikis anzupassen:

196

197

* [[Refined>>url:https://marketplace.atlassian.com/apps/15231/refined-structure-and-theme-confluence?hosting=server&tab=overview||shape="rect"]] und [[Refined Mobile>>url:https://marketplace.atlassian.com/apps/22008/refined-mobile-for-confluence?hosting=server&tab=overview||shape="rect"]]: Theme sowie Einführung des Space-Kategorien. Bessere Unterstützung für mobile Endgeräte

198

* [[No Email Storm>>url:https://marketplace.atlassian.com/apps/42684/no-email-storm?hosting=server&tab=overview||shape="rect"]]: Anpassung der Notification und Watcher Einstellungen in Confluence

199

* [[SAML Single Sign On>>url:https://marketplace.atlassian.com/apps/1212129/saml-single-sign-on-sso-confluence?hosting=server&tab=overview||shape="rect"]]: Anbindung an unser Anmeldesystem Keycloak

200

* [[Sketch for Confluence>>url:https://marketplace.atlassian.com/apps/1211075/sketch-for-confluence-image-editing?hosting=server&tab=overview||shape="rect"]]: Add-on zur Bearbeitung von Bildern und Fotos direkt während des Uploads

201

* [[Scroll Exporter for Confluence>>url:https://marketplace.atlassian.com/apps/24982/scroll-word-exporter-for-confluence?hosting=server&tab=overview||shape="rect"]]: Gut aussehender Export von Confluence Seiten in Word Dokumente

202

* [[Google Drive / Docs for Confluence>>url:https://marketplace.atlassian.com/apps/1216484/google-drive-docs-for-confluence?hosting=server&tab=overview||shape="rect"]]: Plugin zum Einbinden von Google Docs direkt in Confluence

203

* [[Draw.io>>url:https://marketplace.atlassian.com/apps/1210933/draw-io-diagrams-for-confluence?hosting=server&tab=overview||shape="rect"]]: Plugin zum Zeichnen von Graphen und technischen Zeichnungen

204

205

\\

Wiki-Quellcode von How To Wiki