Skip to content

Add clarification that you need an environment for a review app

Release notes

Problem to solve

In the review app scorecard, when configuring a review app, there was a helpful modal when selecting Enable review app on the environments page, but there was no step saying an environment needed to be created to deploy the review app.

Intended users

User experience goal

Add clarification that an environment is a necessary prereq before enabling a review app.

Proposal

Add a step or other indication within the Enable Review app modal that an environment is necessary as a prereq. It would be even better if we could detect that (although I don't think that's possible).

Technical Proposal

  • in enable_review_app_modal.vue:
    • change text/structure to match design, add static site explanation popover
    • add links (Learn more, links to specific example projects, View more example projects)
      • documentation links can use helpPagePath helper like the existing links
      • specific example project URLs can probably just be constants?
  • do a bit of investigation to figure out a way to detect if a review app is configured - if there's a decent way, implement it; if there's no decent way, document findings in this issue

Further details

Permissions and Security

Documentation

Availability & Testing

Available Tier

Feature Usage Metrics

What does success look like, and how can we measure that?

What is the type of buyer?

Is this a cross-stage feature?

Links / references

This page may contain information related to upcoming products, features and functionality. It is important to note that the information presented is for informational purposes only, so please do not rely on the information for purchasing or planning purposes. Just like with all projects, the items mentioned on the page are subject to change or delay, and the development, release, and timing of any products, features, or functionality remain at the sole discretion of GitLab Inc.

Edited by Miranda Fluharty