Draft: Add environment object page

What does this MR do?

Adds an object documentation page for Environment with object description and conceptual model (see screenshot below)

Still Draft, as the layout mapping section is still ongoing.

Figma Link in page: https://www.figma.com/file/0pQXky3SCtdzydXRZSQZm8/Release-Group-%E2%80%A2-Ops-Object-Models?node-id=1%3A740

Does this MR meet the acceptance criteria?

• The MR title and commit message meet the Pajamas commit conventions
• Add a description to this MR explaining the reasons for the proposed change, per say-why-not-just-what
• Include MR scope that reflects the purpose of the change in the description
  • For example, if this MR is focused on usage guidelines, addressing accessibility challenges could be added separately with a different MR
• If creating a new page on Pajamas from scratch, follow the page template structure
• Follow the Pajamas Voice & Tone Guidelines and GitLab Documentation Style Guide
• Link components to and from other related components and patterns on the .md file, where helpful
• If embedding a Figma file, follow the Figma embed guide
• Assign it to a reviewer. All GitLab designers are reviewers, but you can also assign it directly to a maintainer or trainee maintainer
• Apply the correct component label(s)
• Select a milestone or due date

Links

added Pajamas label

assigned to @dfosco

changed the description

@pedroms @npost Here's the Environment conceptual model I've been working on, based on your work for the MR object page

This has been useful in helping me understand the scope and boundaries of Environments, and will serve as the base of the upcoming UI work on the page -- I'm currently working on the Layout section of the doc.

Questions:

1. As someone working outside of the Ops section, is this content useful and understandable for you?
2. The conceptual model description seems relevant to any object created, perhaps it's better to add it in a separate page from Environment and MR, such as How to add a new object?
3. I plan on adding other objects later (Deployment, Release, etc), but does it makes sense to have the entire relationship map represented somewhere?

Let me know if you have any other feedbacks!

Thanks for the ping @dfosco

It would be very useful before answering these questions to see a quick video overview of you telling the story of this object and how it fits into the broader system.

@npost Great idea! Will put a short video together and share it here

@dfosco thanks for working on this and taking the time to contribute it! I'm so excited to see others thinking about objects Sorry for the delay reviewing this, I intend to get to it during this week.

In the meantime, I think Nick's suggestion to create a short walkthrough video wouldn't hurt, if you have the time. Thanks in advance

I would actually caution against the walkthrough video. We should be able to read the docs and understand them based on that. Its a good exercise to go into the documentation blind and see what, if anything, needs to be updated in order to fully understand the content.

After reading the content, and if it is not well understood, then a walkthrough video could be helpful in order to determine what needs to be added. But I would suggest writing down the questions you have and then having Daniel update the MR to address those questions.

@tauriedavis That's a good point! I can definitely expand the description and add better examples, environments can be pretty abstract sometimes.

@pedroms @npost Let me know if you have specific questions, but I'll start expanding the content and add to this MR regardless

@tauriedavis that's fair. As I wrote, a video was not a requirement, I was still going to review this without it.

@dfosco I'd prefer to review the content of this MR independently from the conceptual model you are working on in Figma. For that, would you mind creating a branch from the main Conceptual model Figma for your work on Environments? Let me know when that's done so I can review it in place

@tauriedavis Let me know if there's anything I should be doing different in the format for this MR, it's my first doc contribution to Pajamas

marked the checklist item If [embedding a Figma file][figma-embed], follow the [Figma embed guide][figma-embed-guide] as completed

added 1 commit

• 56aff19d - docs(objects) Add newline at the end of environment object page

Compare with previous version

	1 Error
	253eb5eb: The commit does not comply with conventional commits specifications.

	1 Warning
	This MR will trigger no release

Commit message standards

One or more commit messages do not meet our Git commit message standards. For more information on how to write a good commit message, take a look at Conventional commits.

Here is an example of a good commit message:

feat(progressbar): Improve rendering performance in Edge

Our progressbar component was causing a lot of re-renders in Edge.
This was caused by excessive re-rendering due to floating point errors
in Edge's JavaScript engine.

By utilizing the better-math library we avoid those calculation errors
and we can achieve 120 rendering frames per second again.

This is an example of a bad commit message:

fixed progressbar

No release

This Merge Request will trigger no release. This either means, no commit neither the MR title warrant a semantic release (e.g. only updating CI config); or that all commits and/or the MR title are not properly formatted according to conventional commits rules, in the latter case, you should either:

• Disable Squash commits when merge request is accepted and rewrite the commits history to format commit messages properly
• Enable Squash commits when merge request is accepted and make sure the MR's title complies with conventional commits specifications

Generated by Danger

added 2 commits

• dfe7e30b - docs(objects): Add environment object page
• e063d59d - docs(objects): Add newline at the end of environment object page

Compare with previous version

added 1 commit

• 931057dc - docs(objects): Update Figma embed URL

Compare with previous version

mentioned in issue gitlab-org/gitlab#213589 (closed)

requested review from @tauriedavis

requested review from @pedroms

@pedroms Do you mind reviewing this first since you are familiar with objects?

removed review request for @tauriedavis

@dfosco thought (non-blocking): this introductory text will be applicable to all objects that are added to Pajamas, so it might make sense in the future to create an "Overview" page for the “Objects” section with this content, to avoid duplication and keep things DRY. Just a thought, non-blocking!

@dfosco chore (non-blocking): Is there an issue we can link to in the MR description? Maybe there's an issue that would be closed by this MR? If so, you can add it with Closes {issue-url-or-id} to the MR description.

@dfosco chore: please add this new page to the navigation in https://gitlab.com/gitlab-org/gitlab-services/design.gitlab.com/-/blob/main/nav.json#L295-297

removed review request for @pedroms

added 35 commits

• 931057dc...7741b538 - 32 commits from branch main
• 504c3a16 - docs(objects): Add environment object page
• 3076583a - docs(objects): Add newline at the end of environment object page
• 03ed41d1 - docs(objects): Update Figma embed URL

Compare with previous version

added 1 commit

• 253eb5eb - Add ending parentheses in MR object page

Compare with previous version

mentioned in issue gitlab-org/ci-cd-ux#48 (closed)

mentioned in issue gitlab-org/ci-cd-ux#49 (closed)

added environments label

added pajamasdefine label

mentioned in issue dfosco/notes#21 (closed)

mentioned in issue gitlab-org/ci-cd/release-group/release#105 (closed)

changed milestone to %14.9

unassigned @dfosco

assigned to @dfosco

mentioned in issue gitlab-org/gitlab-design#1824 (closed)

assigned to @rayana and unassigned @dfosco

@pedroms how do you feel about this MR? Should we close it?

requested review from @pedroms

removed review request for @pedroms

mentioned in issue #1257

closed

Hi @dfosco,

We would love to know how you found your code review experience in this merge request! Please leave a or a on this comment to describe your experience.

Once done, please comment @gitlab-bot feedback below and feel free to leave any additional feedback you have in the same comment.

You can also fill out a 5 minute survey to provided additional feedback on how GitLab can improve the contributor experience.

Thanks for your help!