FusionAuth / fusionauth-issues

FusionAuth issue submission project
https://fusionauth.io
91 stars 12 forks source link

Remove inline HTML in API components #2860

Open robotdan opened 2 months ago

robotdan commented 2 months ago

Remove inline HTML in API components

Description

We should not be using inline HTML in Astro components. We should be using the existing components for since, deprecated, etc.

Example usage that should be corrected.

  <APIField name={`${props.base_field_name}.global`} type="Boolean">
    Whether or not this Webhook is used for all Tenants or just for specific Tenants.

    <span class="text-green-600">
    Before 1.37.0
    </span>
    Whether or not this Webhook is used for all events or just for specific Applications.
  </APIField>

In this snippet, the follow code should be removed and replaced with an existing component.

    <span class="text-green-600">
    Before 1.37.0
    </span>

There are a lot of usages like this, so all of the API docs need to be audited for this usage.

The problem with this usage is that it means that we are not using the correct style, and formatting that already exists and is defined in the defined components.

Is this a question about how to use FusionAuth? Please consider posting on the FusionAuth forum instead.

Community guidelines

All issues filed in this repository must abide by the FusionAuth community guidelines.

mooreds commented 2 months ago

Should also update the DocsDevReadme or any other doc around components to make this requirement clear.