Simplify Unleash docs updates (#8925)

Unleash · Dec 17, 2024 · c8300fe · c8300fe
1 parent fdb20e9
commit c8300fe
Show file tree

Hide file tree

Showing 22 changed files with 95 additions and 171 deletions.
diff --git a/README.md b/README.md
@@ -143,7 +143,7 @@ Check out [the CONTRIBUTING.md file](./CONTRIBUTING.md) for contribution guideli
 - 2 [environments](https://docs.getunleash.io/reference/environments)
 - Organize feature flags using [tags](https://docs.getunleash.io/reference/feature-toggles#tags)
 - Out-of-the-box integrations with popular tools ([Slack](https://docs.getunleash.io/addons/slack), [Microsoft Teams](https://docs.getunleash.io/addons/teams), [Datadog](https://docs.getunleash.io/addons/datadog)) + integrate with anything with [webhooks](https://docs.getunleash.io/addons/webhook)
-- [Dashboard for managing technical debt](https://docs.getunleash.io/reference/technical-debt) and [stale flags](https://docs.getunleash.io/reference/technical-debt#stale-and-potentially-stale-toggles)
+- [Insights for managing technical debt](https://docs.getunleash.io/reference/technical-debt) and [stale flags](https://docs.getunleash.io/reference/technical-debt#stale-and-potentially-stale-flags)
 - API-first: _everything_ can be automated. No exceptions.
 - [12 official client SDKs](https://docs.getunleash.io/reference/sdks#official-sdks), and 10 [community-contributed client SDKs](https://docs.getunleash.io/reference/sdks#community-sdks)
 - Run it via Docker with the [official Docker image](https://hub.docker.com/r/unleashorg/unleash-server) or as a pure Node.js application

diff --git a/frontend/src/component/featureTypes/FeatureTypeEdit/FeatureTypeForm/FeatureTypeForm.tsx b/frontend/src/component/featureTypes/FeatureTypeEdit/FeatureTypeForm/FeatureTypeForm.tsx
@@ -151,7 +151,7 @@ export const FeatureTypeForm: VFC<FeatureTypeFormProps> = ({
                                 </p>
                                 <br />
                                 <a
-                                    href='https://docs.getunleash.io/reference/feature-toggles#expected-lifetime'
+                                    href='https://docs.getunleash.io/reference/feature-toggles#feature-flag-types'
                                     target='_blank'
                                     rel='noreferrer'
                                 >

diff --git a/frontend/src/component/project/Project/ProjectHealth/ReportTable/ReportCard/ReportCard.tsx b/frontend/src/component/project/Project/ProjectHealth/ReportTable/ReportCard/ReportCard.tsx
@@ -88,7 +88,7 @@ export const ReportCard = ({ healthReport }: IReportCardProps) => {
                     it will be marked as potentially stale.
                     <Box sx={{ mt: 2 }}>
                         <a
-                            href='https://docs.getunleash.io/reference/technical-debt#stale-and-potentially-stale-toggles'
+                            href='https://docs.getunleash.io/reference/technical-debt#stale-and-potentially-stale-flags'
                             target='_blank'
                             rel='noreferrer'
                         >

diff --git a/src/lib/features/feature-toggle/feature-toggle-controller.ts b/src/lib/features/feature-toggle/feature-toggle-controller.ts
@@ -571,7 +571,7 @@ export default class ProjectFeaturesController extends Controller {
                     tags: ['Features'],
                     operationId: 'staleFeatures',
                     summary: 'Mark features as stale / not stale',
-                    description: `This endpoint marks the provided list of features as either [stale](https://docs.getunleash.io/reference/technical-debt#stale-and-potentially-stale-toggles) or not stale depending on the request body you send. Any provided features that don't exist are ignored.`,
+                    description: `This endpoint marks the provided list of features as either [stale](https://docs.getunleash.io/reference/technical-debt#stale-and-potentially-stale-flags) or not stale depending on the request body you send. Any provided features that don't exist are ignored.`,
                     requestBody: createRequestSchema('batchStaleSchema'),
                     responses: {
                         202: emptyResponse,

diff --git a/src/lib/openapi/spec/deprecated-project-overview-schema.ts b/src/lib/openapi/spec/deprecated-project-overview-schema.ts
@@ -75,7 +75,7 @@ export const deprecatedProjectOverviewSchema = {
             type: 'number',
             example: 50,
             description:
-                "An indicator of the [project's health](https://docs.getunleash.io/reference/technical-debt#health-rating) on a scale from 0 to 100",
+                "An indicator of the [project's health](https://docs.getunleash.io/reference/technical-debt#project-status) on a scale from 0 to 100",
         },
         environments: {
             type: 'array',

diff --git a/src/lib/openapi/spec/health-overview-schema.ts b/src/lib/openapi/spec/health-overview-schema.ts
@@ -75,7 +75,7 @@ export const healthOverviewSchema = {
         health: {
             type: 'integer',
             description:
-                'The overall [health rating](https://docs.getunleash.io/reference/technical-debt#health-rating) of the project.',
+                'The overall [health rating](https://docs.getunleash.io/reference/technical-debt#project-status) of the project.',
             example: 95,
         },
         environments: {

diff --git a/src/lib/openapi/spec/personal-dashboard-schema.ts b/src/lib/openapi/spec/personal-dashboard-schema.ts
@@ -103,7 +103,7 @@ export const personalDashboardSchema = {
                         example: 50,
                         minimum: 0,
                         description:
-                            "An indicator of the [project's health](https://docs.getunleash.io/reference/technical-debt#health-rating) on a scale from 0 to 100",
+                            "An indicator of the [project's health](https://docs.getunleash.io/reference/technical-debt#project-status) on a scale from 0 to 100",
                     },
                     memberCount: {
                         type: 'integer',

diff --git a/src/lib/openapi/spec/project-insights-schema.ts b/src/lib/openapi/spec/project-insights-schema.ts
@@ -28,7 +28,7 @@ export const projectInsightsSchema = {
                 rating: {
                     type: 'integer',
                     description:
-                        "An indicator of the [project's health](https://docs.getunleash.io/reference/technical-debt#health-rating) on a scale from 0 to 100",
+                        "An indicator of the [project's health](https://docs.getunleash.io/reference/technical-debt#project-status) on a scale from 0 to 100",
                     example: 95,
                 },
                 activeCount: {

diff --git a/src/lib/openapi/spec/project-overview-schema.ts b/src/lib/openapi/spec/project-overview-schema.ts
@@ -76,7 +76,7 @@ export const projectOverviewSchema = {
             type: 'number',
             example: 50,
             description:
-                "An indicator of the [project's health](https://docs.getunleash.io/reference/technical-debt#health-rating) on a scale from 0 to 100",
+                "An indicator of the [project's health](https://docs.getunleash.io/reference/technical-debt#project-status) on a scale from 0 to 100",
         },
         environments: {
             type: 'array',

diff --git a/src/lib/openapi/spec/project-schema.ts b/src/lib/openapi/spec/project-schema.ts
@@ -29,7 +29,7 @@ export const projectSchema = {
             type: 'number',
             example: 50,
             description:
-                "An indicator of the [project's health](https://docs.getunleash.io/reference/technical-debt#health-rating) on a scale from 0 to 100",
+                "An indicator of the [project's health](https://docs.getunleash.io/reference/technical-debt#project-status) on a scale from 0 to 100",
         },
         featureCount: {
             type: 'number',

diff --git a/src/lib/routes/admin-api/project/health-report.ts b/src/lib/routes/admin-api/project/health-report.ts
@@ -48,7 +48,7 @@ export default class ProjectHealthReport extends Controller {
                     operationId: 'getProjectHealthReport',
                     summary: 'Get a health report for a project.',
                     description:
-                        'This endpoint returns a health report for the specified project. This data is used for [the technical debt dashboard](https://docs.getunleash.io/reference/technical-debt#the-technical-debt-dashboard)',
+                        'This endpoint returns a health report for the specified project. This data is used for [the technical debt insights](https://docs.getunleash.io/reference/technical-debt)',
                     responses: {
                         200: createResponseSchema('healthReportSchema'),
                         ...getStandardResponses(401, 403, 404),