Wiki source code of DevOps Portal for Users

Version 23.1 by DOaaS Operator on 2025/11/13 15:16

Show last authors
1 Welcome to the DevOps Portal. This guide will walk you through the initial steps to begin your first DevOps project seamlessly.
2
3 Below, you will find a series of actions required to get your project up and running:
4
5 {{toc/}}
6
7
8 = Invitation and activation{{id name="Invitation and activation"/}} =
9
10 To begin using our software solution, you must first receive an invitation email from an administrator who has created your account.
11
12 This email will enable you to activate your account.
13
14 Please see the example below:
15
16 [[image:1763042544636-589.png||data-xwiki-image-style-border="true"]]
17
18 Upon receiving an email containing an invitation link, you can activate your account by either clicking the link directly or copying and pasting it into a new browser window.
19
20 Once completed, you will be directed to a page on our platform confirming the successful activation of your account.
21
22 Please see the example below:
23
24 [[image:1763042597764-495.png||data-xwiki-image-style-border="true"]]
25
26 With your account now created and successfully activated, the next step is to set up your password.
27
28 Upon completing the activation process, the system will automatically send you an email containing a link to create your password.
29
30 Please see the example below:
31
32 [[image:1763042890784-731.png||data-xwiki-image-style-border="true"]]
33
34 Similar to the account activation process, you can create your password by either clicking the link provided in the email or by copying and pasting it into a new browser window.
35
36 Upon completion, you will be directed to a page on our platform prompting you to take further action.
37
38 Please click on the "**Click here to proceed**" link.
39
40 An example is provided below:
41
42 [[image:1763042933491-194.png||data-xwiki-image-style-border="true"]]
43
44
45 (% class="box infomessage" %)
46 (((
47 == Optional Two-Factor Authentication(2FA) configuration ==
48
49 At this stage of your account setup, it is possible that, based on your specific environment configuration, an additional level of authentication may be required.
50
51 If this is the case, the system will automatically prompt you to integrate this requirement into your setup.
52
53 To enable two-factor authentication, you will need a **smartphone **with an authenticator app installed such as **Google Authenticator** or **Microsoft Authenticator**.
54
55 After clicking "**Click here to proceed**" on the previous page, you will be directed to a screen resembling the one shown below:
56
57 [[image:Screenshot 2024-11-19 091818.png||alt="Second Factor Authentication setup" data-xwiki-image-style-border="true" class="img-thumbnail"]]
58
59 After scanning the QR code, enter the code generated by your authenticator application and create a custom identifier to easily remember which smartphone or account can generate the correct one-time code.
60
61 If you are unable to scan the QR code, click on the "**Unable to scan**" link for alternative instructions to obtain the one-time code from your authenticator application.
62
63 Once you follow the instructions provided and click the "**Submit**" button or press **Enter **on your keyboard, you will be directed to the password update page
64 )))
65
66 Whether or not you need to configure the second authentication factor, you will now be redirected to the password update page.
67
68 Here, you can select a new password that meets the required strength criteria.
69
70 Please enter your chosen password twice for confirmation.
71
72 After completing this step, click "**Submit**."
73
74 Below is an example screenshot for your reference:
75
76 [[image:1763043012921-785.png||data-xwiki-image-style-border="true"]]
77
78 Once your password update is **successful**, you will be taken to a confirmation page indicating the update's success and providing a link to the application's login page.
79
80 Below is an example screenshot for your reference:
81
82 [[image:1763043036241-364.png||data-xwiki-image-style-border="true"]]
83
84 With this last step, your account **setup is complete**, and you can now use it to access the application. **Well done**.
85
86
87 = Log in to DevOps Portal{{id name="Log in to DevOps Portal"/}} =
88
89 To access the application, begin by entering its URL into the address bar.
90
91 The application will then automatically direct you to the login screen.
92
93 Please refer to the example screenshot below:
94
95 [[image:1763046215981-831.png||data-xwiki-image-style-border="true"]]
96
97 You can now access the application by entering your email and password and clicking the "**Log in"** button, or by pressing the Enter key on your keyboard.
98
99 Below is an example of how to complete the fields:
100
101 [[image:1763046277604-269.png||data-xwiki-image-style-border="true"]]
102
103
104
105 (% class="box infomessage" %)
106 (((
107 == Optional Two-Factor Authentication(2FA) Request ==
108
109 If you had to set up two-factor authentication (2FA) for each new login, you'll be asked to enter the one-time code generated by your authenticator application.
110
111 Once you've entered the code, click "**Log In**."
112
113 Below is an example screenshot:
114
115 [[image:1763046396687-790.png||data-xwiki-image-style-border="true"]]
116
117
118 )))
119
120 With this last step, you have successfully **logged in** and you can now use the application. **Well done**.
121
122
123 = Forgotten Password{{id name="Forgotten Password"/}} =
124
125 To access the application, in case you have forgotten your password, start by loading the login screen in your browser.
126
127 On this page there is a link with the text "**Forgot Password?**" click on it to be redirected to the login recovery procedure.
128
129 Here is an example screenshot below:
130
131 [[image:1763046215981-831.png||data-xwiki-image-style-border="true"]]
132
133 Once you click on the "**Forgot Password?**" link, you will be shown a new page where you just need to enter your email address and then click "**Submit**" or press enter on your keyboard.
134
135 This action will send your email a link with which you can change your password.
136
137 Here is an example screenshot below:
138
139 [[image:1763046478281-326.png||data-xwiki-image-style-border="true"]]
140
141
142 (% class="box infomessage" %)
143 (((
144 == Optional Two-Factor Authentication(2FA) Request ==
145
146 If you had to set up two-factor authentication (2FA) for each password change, you'll be asked to enter the one-time code generated by your authenticator application.
147
148 Once you've entered the code, click "**Log In**."
149
150 Below is an example screenshot:
151
152 [[image:1763046396687-790.png||data-xwiki-image-style-border="true"]]
153 )))
154
155 You will then have to wait for the **password reset email** to arrive in your **inbox**.
156
157 Of course, it's always a good idea to check the **Spam **section of your inbox or **repeat the steps** if the email doesn't seem to be arriving, before contacting the support.
158
159 Here is a sample screenshot of the email below:
160
161 [[image:1763046618894-195.png||data-xwiki-image-style-border="true"]]
162
163 Once you click on the password reset link, your browser will open to a web page. On this webpage, you will be asked to choose a new password that meets the required security criteria.
164
165 Enter your chosen password twice to confirm.
166
167 After completing this step, click "**Submit**."
168
169 Here's a sample screenshot of the page below:
170
171 [[image:1763046670673-656.png||data-xwiki-image-style-border="true"]]
172
173 With this last step, you have successfully **reset your password**, and you can now use the application. **Well done**.
174
175
176 = Change password{{id name="Change password"/}} =
177
178 If you wish to change your password, the first step is to log in to the portal using your credentials.
179
180 Once you are logged in, locate and click on the "**email"** drop-down menu in the main menu.
181
182 Within the drop-down menu, you will find an option labeled "**Password**" click on this option to proceed with changing your password.
183
184 Below is an example screenshot:
185
186 [[image:1763046796788-374.png||data-xwiki-image-style-border="true"]]
187
188 Once you click on the "**Password**" link, you will be shown a new page.
189
190 On this page, your email address is placed in square brackets.
191
192 You just have to press the "**Request e-mail for new password**" button to send you the email to change your password.
193
194 Here is an example screenshot below:
195
196 [[image:1763046872658-110.png||data-xwiki-image-style-border="true"]]
197
198
199 You will then have to wait for the **password change email** to arrive in your **inbox**.
200
201 Of course, it's always a good idea to check the **Spam **section of your inbox or **repeat the steps** if the email doesn't seem to be arriving, before contacting the support.
202
203 Here is a sample screenshot of the email below:
204
205 [[image:1763046952293-316.png]]
206
207 Once you click on the password change link, your browser will open to a web page. On this webpage, you will be asked to choose a new password that meets the required security criteria.
208
209 Enter your chosen password twice to confirm.
210
211 After completing this step, click "**Submit**."
212
213 Here's a sample screenshot of the page below:
214
215 [[image:Screenshot 2024-11-19 092226.png||alt="Page of password reset" data-xwiki-image-style-border="true" class="img-thumbnail"]]
216
217 With this last step, you have successfully **changed your password**, and you can now use the application. **Well done**.
218
219
220 = Select Languages - Sprachen auswählen{{id name="Select Languages"/}} =
221
222 The DevOps portal is set to **English **by default, which applies to all web pages and sent emails within the system.
223
224 However, there is an option available on each page we created to change the settings and switch to **German (Deutsch)**.
225
226 Here is a sample screenshot below:
227
228 [[image:Screenshot 2024-11-21 152351.png||alt="change language" data-xwiki-image-style-border="true" class="img-thumbnail"]]
229
230 Within the DevOps portal, users have the option to change the language.
231
232 This can be done via the drop-down "**Language**" menu located in the top left corner.
233
234 Any changes made will be applied to the system's web and email pages.
235
236 [[image:Screenshot 2024-11-21 152713.png||alt="change language in the portal" data-xwiki-image-style-border="true" class="img-thumbnail"]]
237
238 With this **last step**, you are now aware of all the possibilities for the selected language. **Well done**.
239
240
241 Wenn das DevOps-Portal auf **Deutsch **eingestellt ist, gilt dies für alle Websites und E-Mails, die innerhalb des Systems versendet werden.
242
243 Auf jeder Seite, die wir erstellt haben, steht jedoch eine Option zur Verfügung, um die Einstellungen zu ändern und auf **Englisch(English)** zu wechseln.
244
245 Hier ist ein Beispiel-Screenshot unten:
246
247 [[image:Screenshot 2024-11-21 152426.png||alt="change language german" data-xwiki-image-style-border="true" class="img-thumbnail"]]
248
249 Innerhalb des DevOps-Portals haben Benutzer die Möglichkeit, die Sprache zu ändern.
250
251 Dies kann über das Dropdown-Menü "**Sprache**" in der oberen linken Ecke erfolgen.
252
253 Alle vorgenommenen Änderungen werden auf die Web- und E-Mail-Seiten des Systems angewendet.
254
255 [[image:Screenshot 2024-11-21 154936.png||alt="change language in the portal german" data-xwiki-image-style-border="true" class="img-thumbnail"]]
256
257 Mit diesem **letzten Schritt** sind Sie sich nun über alle Möglichkeiten für die ausgewählte Sprache im Klaren. **Gut gemacht**.
258
259
260 = The First Access =
261
262 After completing the logging in for the first time, you might find yourself facing a **completely blank page**, as shown in the example screenshot provided below:
263
264 [[image:Screenshot 2024-11-21 152652.png||alt="no projects" data-xwiki-image-style-border="true" class="img-thumbnail"]]
265
266 Please do not be **alarmed**. This situation typically indicates that you have not yet been assigned any projects, or there might be a configuration issue.
267
268 The application itself is **functioning correctly**. To address this matter, there are a few steps you can take.
269
270 If you have **contact **information for the **system administrator**, please reach out to them directly for assistance.
271
272 The administrator will be **able to assign** the necessary project or projects or rectify any configuration **problems**.
273
274 If you do not have direct contact with the administrator, you can easily identify them by navigating to the users page located in the main menu.
275
276 This will provide you with the information needed to reach out to the appropriate person **for support**.
277
278 Once everything has been configured correctly and any necessary project assignments have been made, the page **will no longer be empty**.
279
280 Instead, you will see **links to all the tools **and resources you have access to, enabling you to fully utilize the application.
281
282 Here is a sample screenshot below:
283
284 [[image:Screenshot 2024-11-22 135917.png||alt="nomal login" data-xwiki-image-style-border="true" class="img-thumbnail"]]
285
286 With this last step, you have successfully **made your first access**. **Well done**.
287
288
289 = The Projects Page =
290
291 In the main menu, one of the most important pages you will encounter is the **Projects page**.
292
293 This page provides a comprehensive overview of all the projects that have been assigned to you, along with a detailed view of their various features and attributes.
294
295 Key informantion available on this page include **Project key**, **Type**, **Status**, and **Project Role**.
296
297 To help you better understand, we have provided an example screenshot below:
298
299 [[image:Screenshot 2024-11-22 140014.png||alt="projects page" data-xwiki-image-style-border="true" class="img-thumbnail"]]
300
301 This page also allows you to **search **for projects that you have access to with the search bar under the **Projects **heading.
302
303 While with the **drop-down** menu on the left you can select a **portal user** to see if they have access to the projects you have access to.
304
305 It is important to note that the appearance of this screen may vary depending on your permission level.
306
307 If you have been granted a **higher level of permissions**, your view might look different from the example provided.
308
309 In such cases, you can simply **follow **this link: [[DevOps Portal for Admins>>doc:DevOps Portal for Admins.WebHome]] to access the relevant information.
310
311 For those who need more detailed information about the **individual tools**, we recommend referring to the **specialized pages** dedicated to it.
312
313 These pages offer **in-depth explanations** and **guidance **on how to effectively utilize each tool.
314
315 Here is a list of useful links that you may find helpful for further details:
316
317 * [[Jira>>doc:Jira.WebHome]]
318 * [[Confluence>>doc:Confluence.WebHome]]
319 * [[Bitbucket>>Bitbucket]]
320 * [[Jenkins>>doc:Jenkins.WebHome]]
321 * [[Sonarqube>>doc:SonarQube.WebHome]]
322 * [[Gitea>>doc:Gitea.WebHome]]
323 * [[Harbor>>doc:Harbor.WebHome]]
324 * [[Rancher 2>>doc:Rancher 2.WebHome]]
325
326 With this last step, you have successfully **analized your project page**. **Well done**.
327
328
329 = The Users Page =
330
331 In the main menu, another crucial page you will come across is the **Users **page.
332
333 This page is designed to provide you with a comprehensive overview of all the users who have been **created within the portal**.
334
335 Below, you will find an example screenshot:
336
337 [[image:Screenshot 2024-11-22 140413.png||alt="User page" data-xwiki-image-style-border="true" class="img-thumbnail"]]
338
339 The is a **search bar** located under the Users heading enables you to quickly find the **user you are looking** for by entering relevant keywords.
340
341 Additionally, on the **left side** of the page, you will find a **drop-down **menu that allows you to filter the projects to which you have access.
342
343 This feature helps you to streamline your search and view only the users associated with specific projects.
344
345 You can sort the table in both **ascending **and **descending **order by **simply clicking on the headers** of the columns you wish to sort.
346
347 Moreover, the Users page is equipped with easily accessible **contact **information for the **administrators**.
348
349 The information is presented in a clear and straightforward manner, **minimizing **any potential confusion or **delays in communication**.
350
351 With this last step, you have successfully **analized your user page**. **Well done**.