Add a description text field to environment details

What does this MR do and why?

This MR adds a markdown editor for the environment description. It is based on the backend and database changes from the related MR.

The markdown field is shown on the new and edit pages.
The rendered markup is then shown on the environment details page. We truncate the description to 3 lines (default) with the Read more button.

MR acceptance checklist

Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

Description	Screenshot
Edit/new environment
Less than 3 lines
More than 3 lines
More than 3 lines

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

1. Go to the project -> Operate -> Environments
2. Create an environment.
3. On the create form verify the description field.
4. Save and verify how the description is rendered on the details page.
5. Edit the environment and verify the changes.

Related to #450944 (closed)

changed milestone to %17.5

added Category:Environment Management GitLab Free GitLab Premium GitLab Ultimate Technical Writing UI text UX co-create devopsdeploy direction documentation frontend groupenvironments sectioncd typefeature workflowin dev labels

assigned to @anna_vovchenko

added 1 commit

• 233e3e3c - Add description text field to environment details

Compare with previous version

added backend label

	1 Warning
	This merge request contains lines with testid selectors. Please ensure e2e:test-on-omnibus job is run.

testid selectors

The following changed lines in this MR contain testid selectors:

app/assets/javascripts/environments/components/environment_form.vue

+            data-testid="save-environment"

app/assets/javascripts/environments/components/environments_detail_header.vue

+        data-testid="environment-description-content"

If the e2e:test-on-omnibus job in the qa stage has run automatically, please ensure the tests are passing. If the job has not run, please start the manual:e2e-test-pipeline-generate job in the prepare stage and ensure the tests in follow-up:e2e:test-on-omnibus-ee pipeline are passing.

For the list of known failures please refer to the latest pipeline triage issue.

If your changes are under a feature flag, please check our Testing with feature flags documentation for instructions.

Reviewer roulette

Category	Reviewer	Maintainer
backend	@schmil.monderer (UTC+3, same timezone as author)	@johnmason (UTC-4, 7 hours behind author)
frontend	@dstull (UTC-4, 7 hours behind author)	@kpalchyk (UTC+3, same timezone as author)
UX	@emilybauman (UTC-4, 7 hours behind author)	Maintainer review is optional for UX

Please refer to documentation page for guidance on how you can benefit from the Reviewer Roulette, or use the GitLab Review Workload Dashboard to find other available reviewers.

If needed, you can retry the danger-review job that generated this comment.

Generated by Danger

added 1 commit

• 86ece133 - Add description text field to environment details

Compare with previous version

@emilybauman, could you please take a look when you have time? I didn't add a gradient to the show more button when the description is truncated as I used GitLab UI GlTruncate component, which doesn't indicate the state. Do you think it's acceptable just to show the show more button?

---

@johnmason, could you please do the backend review? As the backend changes are pretty small, do you think we could skip the initial review?

---

@syarynovskyi, could you please do the initial frontend review? The MR is not ready for merge until !166941 (merged) is merged, but I think we can start the review process in parallel.

requested review from @emilybauman, @johnmason, and @syarynovskyi

approved this merge request

added pipeline:mr-approved label

removed review request for @emilybauman

added pipelinetier-3 pipeline:run-e2e-omnibus-once labels

approved this merge request

removed review request for @syarynovskyi

requested review from @kpalchyk

approved this merge request

removed review request for @johnmason