Frontend: Change details page to use new description field
Summary
Currently, we are using non_gfm_markdown.vue
. This code was added via community contribution. This caused us to have to override a bottom margin imposed by bootstrap. As it stands today, there is no use of GlMarkdown in the platform.
Proposal
- The description in the catalog resources list will only support links and no other forms of markdown.
- The description in the catalog details page will receive an html field from the GraphQL query and display that in the page header.
From the discussion in #460533 (comment 1919137221), the new graphQL field being created in #463571 (closed) instead of the description
field will be used and get rid of using non-glfm-markdown
component in the client.
Confirm purpose and User Reception (how does this benefit the user?)
Content will be consistent and presentable to users when looking at the details page for any component type in the future.
Additional details
Some relevant technical details, if applicable, such as:
- Does this need a feature flag?
- Does there need to be an associated instrumentation issue created related to this work?
- Is there an example response showing the data structure that should be returned (new endpoints only)?
- What permissions should be used?
- Is this EE or CE?
-
EE -
CE
-
- Additional comments:
Implementation Table
Group | Issue Link |
---|---|
backend | Backend: Create new field in catalog details AP... (#463571 - closed) |
frontend |
|
Links/References
Edited by Mark Nuzzo