Confluence - XWiki

DevOps as a Service includes a hosted and managed version of Atlassian Confluence. Please check out the[[ vendor provided documentation>>url:https://confluence.atlassian.com/confcloud||shape="rect"]] to learn how to work in Confluence spaces. You can skip any documentation related to Confluence installation or administration.

2

3

4

5

= First steps in Confluence =

6

7

Select **Projects** in SDPortal, then click on //Confluence// in the **Tools** section:

8

9

[[image:attach:image2019-8-6_10-43-24.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="1109"]]

10

11

**Log in** to Confluence with your username and your password:

12

13

[[image:attach:image2019-8-6_10-45-13.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" height="250"]]

14

15

The default space screen appears.

16

17

[[image:attach:image2019-8-6_10-53-43.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="1109"]]

18

19

= Create the first page =

20

21

Click **Create from template** (the three dots next to Create)

22

23

[[image:attach:image2019-8-6_10-55-31.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" height="250"]]

24

25

You can see the different page templates, select Blank page, then click** Create** at the bottom:

26

27

[[image:attach:image2019-8-6_10-57-4.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="900"]]

28

29

= Link a Jira issue into the page content =

30

31

If you would like to insert a link to a Jira ticket in your page content (at first you have to create the exact ticket), click on the **Insert macros** button and select **Jira Issue/Filter:**

32

[[image:attach:image2019-8-6_11-49-3.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="1109"]]

33

34

Type the ticket's name (key or summary) on the top (in this example the //Deploy microservices// ticket can be inserted), then click **Insert** at the bottom:

35

36

[[image:attach:image2019-8-6_11-50-11.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="700"]]

37

38

To see the result, you have to **Publish** the page.

39

40

[[image:attach:image2019-8-6_11-56-19.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="1109"]]

41

42

Now the link to the ticket is created and the //status// of the ticket (in the example it is IN PROGRESS) is shown. Clicking the link will open the ticket in Jira.

43

44

[[image:attach:image2019-8-6_11-59-39.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="1109"]]

45

46

If the //status of the ticket changes//, this will be reflected in the Confluence page (in this example the ticket status is changed to DONE).

47

48

[[image:attach:image2019-8-6_12-2-51.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="1109"]]

49

50

The created page can be seen on the left side under **PAGE TREE** (which represents the hierarchy of the created pages also)

51

52

[[image:attach:image2019-8-6_12-11-6.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="500"]]

53

54

You can create other pages by repeating this method (create, then publish).

55

56

= Create the second page and link to the first page =

57

58

In this example a new blank page is created to show the backlog of the progress of the project.

59

60

To create a table click on the **Insert table** icon:

61

62

[[image:attach:image2019-8-6_12-16-1.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="800"]]

63

64

Insert the Jira tickets in the Summary column and the explanation in the Description column.

65

66

[[image:attach:image2019-8-6_12-20-18.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="1109"]]

67

68

To link this page to the first page, just select the first page (in this example the //Microservices// page), then click **Edit**

69

70

Click the **Insert macros** icon, then click the** Insert link** option.

71

72

[[image:attach:image2019-8-6_12-52-4.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="1109"]]

73

74

In the Insert link window, start to type the title of the page and select from the results.

75

76

[[image:attach:image2019-8-6_12-53-16.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="900"]]

77

78

You can change the text of the link in the **Link text** field, in this example it is not changed.

79

80

To create the link click on **Insert button** on the bottom.

81

82

[[image:attach:image2019-8-6_12-54-50.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="900"]]

83

84

You can see the link immediately, in this example the //Backlog// link (marked as blue):

85

86

[[image:attach:image2019-8-6_14-11-20.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" height="250"]]

87

88

You have to **Update** (publish again) the page to test the link:

89

90

[[image:attach:image2019-8-6_13-29-9.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="800"]]

91

92

Every time you modify your content, you can see the results by clicking Update. You can also set the //notify watchers// option to if you would like to notify other users about the changes.

93

94

Clicking the created link (in this example Backlog) loads the linked page:

95

96

[[image:attach:image2019-8-6_13-56-21.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" height="114"]]

97

98

= Setup Page Hierarchy =

99

100

If you created at least two pages you can setup the page hierarchy (it will appear under PAGE TREE on the left).

101

102

In this example we have Microservices that can be moved below the Backlog page.

103

104

Select the page that you would like to move in the hierarchy of the pages, then click **Page menu** (next to Share button with the three dots), and select **Move**:

105

106

[[image:attach:image2019-8-6_14-13-4.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="1109"]]

107

108

Type the name and select the new parent page (in this example Backlog):

109

110

[[image:attach:image2019-8-6_14-14-43.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="1109"]]

111

112

Click **Move** at the bottom:

113

114

[[image:attach:image2019-8-6_14-16-17.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="900"]]

115

116

Now the moved page is shown below the selected page in the PAGE TREE:

117

118

[[image:attach:image2019-8-6_14-17-37.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="900"]]

119

120

= Table of Contents =

121

122

If you would like to add a table of contents to your page, at first you have to create the titles by selecting one of the Heading formats for the text:

123

124

[[image:attach:image2019-8-6_14-28-0.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="1109"]]

125

126

Then click **Insert macros** icon and select **Table of Contents**.

127

128

[[image:attach:image2019-8-6_14-28-48.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="1109"]]

129

130

A dialog pops up that let's you customize certain aspects of the table of contents (in this example nothing is changed). Click **Insert** once you're done:

131

132

[[image:attach:image2019-8-6_14-30-4.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="900"]]

133

134

Now the **Table of Contents** macro appears at the last cursor position on the page:

135

136

[[image:attach:image2019-8-6_14-32-14.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" height="543" width="500"]]

137

138

To check the macro simply **Update** the page and the Table of contents is created from your page's headings:

139

140

[[image:attach:image2019-8-6_14-36-21.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" height="502" width="500"]]

version	line-number	content
1.1	1	DevOps as a Service includes a hosted and managed version of Atlassian Confluence. Please check out the[[ vendor provided documentation>>url:https://confluence.atlassian.com/confcloud\|\|shape="rect"]] to learn how to work in Confluence spaces. You can skip any documentation related to Confluence installation or administration.
	2
	3	{{toc/}}
	4
	5	= First steps in Confluence =
	6
	7	Select Projects in SDPortal, then click on //Confluence// in the Tools section:
	8
	9	[[image:attach:image2019-8-6_10-43-24.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="1109"]]
	10
	11	Log in to Confluence with your username and your password:
	12
	13	[[image:attach:image2019-8-6_10-45-13.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" height="250"]]
	14
	15	The default space screen appears.
	16
	17	[[image:attach:image2019-8-6_10-53-43.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="1109"]]
	18
	19	= Create the first page =
	20
	21	Click Create from template (the three dots next to Create)
	22
	23	[[image:attach:image2019-8-6_10-55-31.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" height="250"]]
	24
	25	You can see the different page templates, select Blank page, then click Create at the bottom:
	26
	27	[[image:attach:image2019-8-6_10-57-4.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="900"]]
	28
	29	= Link a Jira issue into the page content =
	30
	31	If you would like to insert a link to a Jira ticket in your page content (at first you have to create the exact ticket), click on the Insert macros button and select Jira Issue/Filter:
	32	[[image:attach:image2019-8-6_11-49-3.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="1109"]]
	33
	34	Type the ticket's name (key or summary) on the top (in this example the //Deploy microservices// ticket can be inserted), then click Insert at the bottom:
	35
	36	[[image:attach:image2019-8-6_11-50-11.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="700"]]
	37
	38	To see the result, you have to Publish the page.
	39
	40	[[image:attach:image2019-8-6_11-56-19.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="1109"]]
	41
	42	Now the link to the ticket is created and the //status// of the ticket (in the example it is IN PROGRESS) is shown. Clicking the link will open the ticket in Jira.
	43
	44	[[image:attach:image2019-8-6_11-59-39.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="1109"]]
	45
	46	If the //status of the ticket changes//, this will be reflected in the Confluence page (in this example the ticket status is changed to DONE).
	47
	48	[[image:attach:image2019-8-6_12-2-51.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="1109"]]
	49
	50	The created page can be seen on the left side under PAGE TREE (which represents the hierarchy of the created pages also)
	51
	52	[[image:attach:image2019-8-6_12-11-6.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="500"]]
	53
	54	You can create other pages by repeating this method (create, then publish).
	55
	56	= Create the second page and link to the first page =
	57
	58	In this example a new blank page is created to show the backlog of the progress of the project.
	59
	60	To create a table click on the Insert table icon:
	61
	62	[[image:attach:image2019-8-6_12-16-1.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="800"]]
	63
	64	Insert the Jira tickets in the Summary column and the explanation in the Description column.
	65
	66	[[image:attach:image2019-8-6_12-20-18.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="1109"]]
	67
	68	To link this page to the first page, just select the first page (in this example the //Microservices// page), then click Edit
	69
	70	Click the Insert macros icon, then click the Insert link option.
	71
	72	[[image:attach:image2019-8-6_12-52-4.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="1109"]]
	73
	74	In the Insert link window, start to type the title of the page and select from the results.
	75
	76	[[image:attach:image2019-8-6_12-53-16.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="900"]]
	77
	78	You can change the text of the link in the Link text field, in this example it is not changed.
	79
	80	To create the link click on Insert button on the bottom.
	81
	82	[[image:attach:image2019-8-6_12-54-50.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="900"]]
	83
	84	You can see the link immediately, in this example the //Backlog// link (marked as blue):
	85
	86	[[image:attach:image2019-8-6_14-11-20.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" height="250"]]
	87
	88	You have to Update (publish again) the page to test the link:
	89
	90	[[image:attach:image2019-8-6_13-29-9.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="800"]]
	91
	92	Every time you modify your content, you can see the results by clicking Update. You can also set the //notify watchers// option to if you would like to notify other users about the changes.
	93
	94	Clicking the created link (in this example Backlog) loads the linked page:
	95
	96	[[image:attach:image2019-8-6_13-56-21.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" height="114"]]
	97
	98	= Setup Page Hierarchy =
	99
	100	If you created at least two pages you can setup the page hierarchy (it will appear under PAGE TREE on the left).
	101
	102	In this example we have Microservices that can be moved below the Backlog page.
	103
	104	Select the page that you would like to move in the hierarchy of the pages, then click Page menu (next to Share button with the three dots), and select Move:
	105
	106	[[image:attach:image2019-8-6_14-13-4.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="1109"]]
	107
	108	Type the name and select the new parent page (in this example Backlog):
	109
	110	[[image:attach:image2019-8-6_14-14-43.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="1109"]]
	111
	112	Click Move at the bottom:
	113
	114	[[image:attach:image2019-8-6_14-16-17.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="900"]]
	115
	116	Now the moved page is shown below the selected page in the PAGE TREE:
	117
	118	[[image:attach:image2019-8-6_14-17-37.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="900"]]
	119
	120	= Table of Contents =
	121
	122	If you would like to add a table of contents to your page, at first you have to create the titles by selecting one of the Heading formats for the text:
	123
	124	[[image:attach:image2019-8-6_14-28-0.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="1109"]]
	125
	126	Then click Insert macros icon and select Table of Contents.
	127
	128	[[image:attach:image2019-8-6_14-28-48.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="1109"]]
	129
	130	A dialog pops up that let's you customize certain aspects of the table of contents (in this example nothing is changed). Click Insert once you're done:
	131
	132	[[image:attach:image2019-8-6_14-30-4.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" width="900"]]
	133
	134	Now the Table of Contents macro appears at the last cursor position on the page:
	135
	136	[[image:attach:image2019-8-6_14-32-14.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" height="543" width="500"]]
	137
	138	To check the macro simply Update the page and the Table of contents is created from your page's headings:
	139
	140	[[image:attach:image2019-8-6_14-36-21.png\|\|data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" height="502" width="500"]]

Wiki source code of Confluence