US_11.010 | Welcome Dashboard > Edit Description Functionality

[iuriiivanov]

ID: US_11.010 | Welcome Dashboard > Edit Description Functionality

Description:

As a Jenkins user
I want to see and use the “Edit description” button in the top-right corner of the page, directly under the Admin, Search, and Manage Jenkins icons
So that I can easily update the dashboard description and provide context about my Jenkins instance or visible jobs/folders.

Acceptance Criteria:

After logging in, the user is redirected to the application's start page.
On this page, the user can:
1. Button visibility on an empty Welcome Page
When there are no jobs or folders in Jenkins, you will see the Welcome Page. The "Edit description" button will appear in the top-right corner. It is located under the Admin, Search, and Manage Jenkins icons. Clicking this button opens a text area. This area is editable.
2. Button visibility on the main Dashboard with jobs/folders
When jobs or folders are displayed on the main Dashboard, the "Edit description" button will remain visible. It will continue to be located in its usual position, which is the top-right corner below the icons. The functionality of this button will remain unchanged.
3. The text area opens on click
Click "Edit description." A text box appears. You can change or add to the description. Save and cancel buttons are shown.
4. Preview
When a user clicks "Edit description," a preview control appears. It is clickable and shows up right under the text area. This control becomes active as soon as the text area is visible. Clicking the preview will show how the unsaved text looks. The user can see their content exactly as it will appear when saved.
5. Hide preview
When a user clicks "Preview," the system shows the rendered text. Then, the "Hide preview" button appears near Preview. This "Hide preview" button only appears after the user clicks "Preview." It was not visible before. If the user clicks "Hide preview," the system hides the preview area. The interface then returns to plain text editing. All the text the user entered stays in the editor. The "Hide preview" action simply toggles the preview's visibility. It does not change the text. It also does not affect saving or canceling.
6. Save description
When I input text into the editor and select 'Save', the modified description should be displayed on the page and remain visible after a page refresh.
7. Cancel behavior:
Clicking Cancel discards changes. The previous view remains.
8. Empty description:
Saving an empty description should be accepted.

---

Author: @AnnaIsychko