Integrate the Terraform README into the response sent to the front end

Proposal

Integrate the persisted documentation data into the response sent to the frontend.

added to epic &12408

@trizzi, Please add a group or category label to identify issue ownership.

You can refer to the Features by Group handbook page for guidance.

If you are unsure about the correct group, please do not leave the issue without a group label, and refer to GitLab's shared responsibility functionality guidelines for more information on how to triage this kind of issue.

This message was generated automatically. You're welcome to improve it.

changed the description

added Category:Package Registry devopspackage grouppackage registry sectionci typefeature labels

changed milestone to %Backlog

changed milestone to %16.11

mentioned in issue #446263 (closed)

added Package:P1 label

added Deliverable workflowrefinement labels

Setting health status to on track as the milestone has just begun.

Issue participants are welcome to override this by setting the health status to another value.

changed health status to on track

added backend label

changed milestone to %17.0

marked this issue as blocking #438060 (closed)

mentioned in issue #438060 (closed)

mentioned in issue #451600 (closed)

This issue is scheduled for completion in this milestone but doesn't have an assignee. Changing health status to 'needs attention'.

Issue participants are welcome to override this by setting the health status to another value.

changed health status to needs attention

changed milestone to %17.1

removed health status needs attention

mentioned in issue #438058 (closed)

mentioned in issue #458781 (closed)

Setting health status to on track as the milestone has just begun.

Issue participants are welcome to override this by setting the health status to another value.

changed health status to on track

assigned to @mkhalifa3

set weight to 1

added workflowin dev label and removed workflowrefinement label

added Terraform Registry label

mentioned in merge request !154567 (merged)

added workflowin review label and removed workflowin dev label

Async update

Status

In review: Integrate Terraform module metadata into fronte... (!154567 - merged)

Notes

• backend reviewer: In progress.

Async update

Status

In review: Integrate Terraform module metadata into fronte... (!154567 - merged)

Notes

• backend reviewer: Approved.
• backend maintainer: In progress.

Thanks for the work on this @mkhalifa3

Is a GraphQL API part of this issue? Making sure that exists when we pick Terraform registry UI to use GraphQL (#435850)

Thanks @rchanila!

No, I integrated the metadata into the existing rest API. I would check with @trizzi if we need to schedule Terraform registry UI to use GraphQL (#435850) before working on Add the Terraform README to the UI (#438060 - closed).

The current state is to use the existing rest API, which has the metadata integrated and ready to be displayed.

I just scheduled the GraphQL work for 17.2. Which will put the UI update in 17.3. Thank you both!

@trizzi @mkhalifa3 I want to clarify Add the Terraform README to the UI (#438060 - closed) does not need to depend on Terraform registry UI to use GraphQL (#435850). In fact, since it does not depend on a GraphQL API & hence might not violate multi version compatibility, this can technically be released together in the same milestone.

When we want to implement Terraform registry UI to use GraphQL (#435850), I have verified that we can use the existing packages GraphQL API for the refactoring.

I don't want the issue to be blocked from completion because of missing GraphQL API, so I'd suggest adding GraphQL support for terraform metadata similar to https://gitlab.com/gitlab-org/gitlab/-/blob/0b3405f5c8db1f61fd91d53909aac4cd7d1c962e/app/graphql/types/packages/maven/metadatum_type.rb

This can be either in this issue or another one.

Nice, thanks for calling that out @rchanila. Does that mean that I don't need to schedule #435850 in 17.2?

Up to you @trizzi, since I'm not sure if there's anything else you'd like me to prioritise, Terraform registry UI to use GraphQL (#435850) is close to frontend-weight3 since multiple APIs & UX flow is involved.

Either ways, we need the GraphQL API which sends readme if want to incorporate Add the Terraform README to the UI (#438060 - closed) within the migrated UI, so I've created Add terraform metadata graphql type (#465423 - closed) since we want to close this issue.

We can use workaround using rails templates until then but to complete VueX to apollo migration, it would be good to have the GraphQL API.

added workflowverification label and removed workflowin review label

mentioned in issue #465423 (closed)

Async update

Status

Deployed & Validated on gitlab.com.

Notes

Closing the issue as resolved.

closed

added workflowcomplete label and removed workflowverification label