mirror of
https://github.com/Unleash/unleash.git
synced 2025-01-31 00:16:47 +01:00
refactor: improve the text for docs links (#904)
* refactor: improve the text for docs links * Update src/component/admin/apiToken/CreateApiToken/CreateApiToken.tsx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/component/admin/projectRoles/CreateProjectRole/CreateProjectRole.tsx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/component/admin/projectRoles/EditProjectRole/EditProjectRole.tsx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/component/admin/users/CreateUser/CreateUser.tsx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/component/admin/users/EditUser/EditUser.tsx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/component/context/CreateUnleashContext/CreateUnleashContext.tsx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/component/context/EditContext/EditContext.tsx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/component/strategies/CreateStrategy/CreateStrategy.tsx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Update src/component/strategies/EditStrategy/EditStrategy.tsx Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * refactor: improve docs link texts Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
This commit is contained in:
olav
GitHub
parent
984e75a03b
commit
1fd6f2a60a
@ -78,7 +78,8 @@ export const CreateApiToken = () => {
|
||||
loading={loading}
|
||||
title="Create Api Token"
|
||||
description="In order to connect to Unleash clients will need an API token to grant access. A client SDK will need to token with 'client privileges', which allows them to fetch feature toggle configuration and post usage metrics back."
|
||||
documentationLink="https://docs.getunleash.io/user_guide/api-token"
|
||||
documentationLink="https://docs.getunleash.io/reference/api-tokens-and-client-keys"
|
||||
documentationLinkLabel="API tokens documentation"
|
||||
formatApiCode={formatApiCode}
|
||||
>
|
||||
<ApiTokenForm
|
||||
|
||||
@ -76,7 +76,8 @@ const CreateProjectRole = () => {
|
||||
description="A project role can be
|
||||
customised to limit access
|
||||
to resources within a project"
|
||||
documentationLink="https://docs.getunleash.io/how-to/how-to-create-and-assign-custom-project-roles"
|
||||
documentationLink="https://docs.getunleash.io/user_guide/rbac#custom-project-roles"
|
||||
documentationLinkLabel="Project roles documentation"
|
||||
formatApiCode={formatApiCode}
|
||||
>
|
||||
<ProjectRoleForm
|
||||
|
||||
@ -104,7 +104,8 @@ const EditProjectRole = () => {
|
||||
description="A project role can be
|
||||
customised to limit access
|
||||
to resources within a project"
|
||||
documentationLink="https://docs.getunleash.io/how-to/how-to-create-and-assign-custom-project-roles"
|
||||
documentationLink="https://docs.getunleash.io/user_guide/rbac#custom-project-roles"
|
||||
documentationLinkLabel="Project roles documentation"
|
||||
formatApiCode={formatApiCode}
|
||||
>
|
||||
<ProjectRoleForm
|
||||
|
||||
@ -81,7 +81,8 @@ const CreateUser = () => {
|
||||
title="Create Unleash user"
|
||||
description="In order to get access to Unleash needs to have an Unleash root role as Admin, Editor or Viewer.
|
||||
You can also add the user to projects as member or owner in the specific projects."
|
||||
documentationLink="https://docs.getunleash.io/user_guide/user-management"
|
||||
documentationLink="https://docs.getunleash.io/user_guide/rbac#standard-roles"
|
||||
documentationLinkLabel="User management documentation"
|
||||
formatApiCode={formatApiCode}
|
||||
>
|
||||
<UserForm
|
||||
|
||||
@ -77,7 +77,8 @@ const EditUser = () => {
|
||||
title="Edit user"
|
||||
description="In order to get access to Unleash needs to have an Unleash root role as Admin, Editor or Viewer.
|
||||
You can also add the user to projects as member or owner in the specific projects."
|
||||
documentationLink="https://docs.getunleash.io/user_guide/user-management"
|
||||
documentationLink="https://docs.getunleash.io/user_guide/rbac#standard-roles"
|
||||
documentationLinkLabel="User management documentation"
|
||||
formatApiCode={formatApiCode}
|
||||
>
|
||||
<UserForm
|
||||
|
||||
@ -21,7 +21,7 @@ interface ICreateProps {
|
||||
title: string;
|
||||
description: string;
|
||||
documentationLink: string;
|
||||
documentationLinkLabel?: string;
|
||||
documentationLinkLabel: string;
|
||||
loading?: boolean;
|
||||
modal?: boolean;
|
||||
formatApiCode: () => string;
|
||||
|
||||
@ -77,7 +77,8 @@ export const CreateUnleashContext = ({
|
||||
title="Create context"
|
||||
description="Context fields are a basic building block used in Unleash to control roll-out.
|
||||
They can be used together with strategy constraints as part of the activation strategy evaluation."
|
||||
documentationLink="https://docs.getunleash.io/how-to/how-to-define-custom-context-fields"
|
||||
documentationLink="https://docs.getunleash.io/user_guide/unleash_context#custom-context-fields"
|
||||
documentationLinkLabel="Context fields documentation"
|
||||
formatApiCode={formatApiCode}
|
||||
modal={modal}
|
||||
>
|
||||
|
||||
@ -79,7 +79,8 @@ export const EditContext = () => {
|
||||
title="Edit context"
|
||||
description="Context fields are a basic building block used in Unleash to control roll-out.
|
||||
They can be used together with strategy constraints as part of the activation strategy evaluation."
|
||||
documentationLink="https://docs.getunleash.io/how-to/how-to-define-custom-context-fields"
|
||||
documentationLink="https://docs.getunleash.io/user_guide/unleash_context#custom-context-fields"
|
||||
documentationLinkLabel="Context fields documentation"
|
||||
formatApiCode={formatApiCode}
|
||||
>
|
||||
<ContextForm
|
||||
|
||||
@ -87,6 +87,7 @@ const CreateEnvironment = () => {
|
||||
enabling the feature toggle in the
|
||||
production environment."
|
||||
documentationLink="https://docs.getunleash.io/user_guide/environments"
|
||||
documentationLinkLabel="Environments documentation"
|
||||
formatApiCode={formatApiCode}
|
||||
>
|
||||
<EnvironmentForm
|
||||
|
||||
@ -73,6 +73,7 @@ const EditEnvironment = () => {
|
||||
enabling the feature toggle in the
|
||||
production environment."
|
||||
documentationLink="https://docs.getunleash.io/user_guide/environments"
|
||||
documentationLinkLabel="Environments documentation"
|
||||
formatApiCode={formatApiCode}
|
||||
>
|
||||
<EnvironmentForm
|
||||
|
||||
@ -81,6 +81,7 @@ const CreateFeature = () => {
|
||||
description="Feature toggles support different use cases, each with their own specific needs such as simple static routing or more complex routing.
|
||||
The feature toggle is disabled when created and you decide when to enable"
|
||||
documentationLink="https://docs.getunleash.io/advanced/feature_toggle_types"
|
||||
documentationLinkLabel="Feature toggle types documentation"
|
||||
formatApiCode={formatApiCode}
|
||||
>
|
||||
<FeatureForm
|
||||
|
||||
@ -83,6 +83,7 @@ const EditFeature = () => {
|
||||
description="Feature toggles support different use cases, each with their own specific needs such as simple static routing or more complex routing.
|
||||
The feature toggle is disabled when created and you decide when to enable"
|
||||
documentationLink="https://docs.getunleash.io/advanced/feature_toggle_types"
|
||||
documentationLinkLabel="Feature toggle types documentation"
|
||||
formatApiCode={formatApiCode}
|
||||
>
|
||||
<FeatureForm
|
||||
|
||||
@ -15,6 +15,7 @@ import {
|
||||
featureStrategyHelp,
|
||||
formatFeaturePath,
|
||||
createStrategyPayload,
|
||||
featureStrategyDocsLinkLabel,
|
||||
} from '../FeatureStrategyEdit/FeatureStrategyEdit';
|
||||
import { getStrategyObject } from 'utils/getStrategyObject';
|
||||
import { useStrategies } from 'hooks/api/getters/useStrategies/useStrategies';
|
||||
@ -79,6 +80,7 @@ export const FeatureStrategyCreate = () => {
|
||||
title={formatStrategyName(strategyName)}
|
||||
description={featureStrategyHelp}
|
||||
documentationLink={featureStrategyDocsLink}
|
||||
documentationLinkLabel={featureStrategyDocsLinkLabel}
|
||||
formatApiCode={() =>
|
||||
formatAddStrategyApiCode(
|
||||
projectId,
|
||||
|
||||
@ -90,6 +90,7 @@ export const FeatureStrategyEdit = () => {
|
||||
title={formatStrategyName(strategy.name ?? '')}
|
||||
description={featureStrategyHelp}
|
||||
documentationLink={featureStrategyDocsLink}
|
||||
documentationLinkLabel={featureStrategyDocsLinkLabel}
|
||||
formatApiCode={() =>
|
||||
formatUpdateStrategyApiCode(
|
||||
projectId,
|
||||
@ -170,3 +171,5 @@ export const featureStrategyHelp = `
|
||||
|
||||
export const featureStrategyDocsLink =
|
||||
'https://docs.getunleash.io/user_guide/activation_strategy';
|
||||
|
||||
export const featureStrategyDocsLinkLabel = 'Strategies documentation';
|
||||
|
||||
@ -74,6 +74,7 @@ const CreateProject = () => {
|
||||
title="Create project"
|
||||
description="Projects allows you to group feature toggles together in the management UI."
|
||||
documentationLink="https://docs.getunleash.io/user_guide/projects"
|
||||
documentationLinkLabel="Projects documentation"
|
||||
formatApiCode={formatApiCode}
|
||||
>
|
||||
<ProjectForm
|
||||
|
||||
@ -73,6 +73,7 @@ const EditProject = () => {
|
||||
title="Edit project"
|
||||
description="Projects allows you to group feature toggles together in the management UI."
|
||||
documentationLink="https://docs.getunleash.io/user_guide/projects"
|
||||
documentationLinkLabel="Projects documentation"
|
||||
formatApiCode={formatApiCode}
|
||||
>
|
||||
<ProjectForm
|
||||
|
||||
@ -78,7 +78,7 @@ export const CreateSegment = () => {
|
||||
title="Create segment"
|
||||
description={segmentsFormDescription}
|
||||
documentationLink={segmentsDocsLink}
|
||||
documentationLinkLabel="More about segments"
|
||||
documentationLinkLabel="Segments documentation"
|
||||
formatApiCode={formatApiCode}
|
||||
>
|
||||
<SegmentForm
|
||||
|
||||
@ -81,7 +81,7 @@ export const EditSegment = () => {
|
||||
title="Edit segment"
|
||||
description={segmentsFormDescription}
|
||||
documentationLink={segmentsDocsLink}
|
||||
documentationLinkLabel="More about segments"
|
||||
documentationLinkLabel="Segments documentation"
|
||||
formatApiCode={formatApiCode}
|
||||
>
|
||||
<SegmentForm
|
||||
|
||||
@ -74,6 +74,7 @@ export const CreateStrategy = () => {
|
||||
description="The strategy type and the parameters will be selectable when adding an activation strategy to a toggle in the environments.
|
||||
The parameter defines the type of activation strategy. E.g. you can create a type 'Teams' and add a parameter 'List'. Then it's easy to add team names to the activation strategy"
|
||||
documentationLink="https://docs.getunleash.io/advanced/custom_activation_strategy"
|
||||
documentationLinkLabel="Custom strategies documentation"
|
||||
formatApiCode={formatApiCode}
|
||||
>
|
||||
<StrategyForm
|
||||
|
||||
@ -77,6 +77,7 @@ export const EditStrategy = () => {
|
||||
description="The strategy type and the parameters will be selectable when adding an activation strategy to a toggle in the environments.
|
||||
The parameter defines the type of activation strategy. E.g. you can create a type 'Teams' and add a parameter 'List'. Then it's easy to add team names to the activation strategy"
|
||||
documentationLink="https://docs.getunleash.io/advanced/custom_activation_strategy"
|
||||
documentationLinkLabel="Custom strategies documentation"
|
||||
formatApiCode={formatApiCode}
|
||||
>
|
||||
<StrategyForm
|
||||
|
||||
@ -64,6 +64,7 @@ const CreateTagType = () => {
|
||||
title="Create tag type"
|
||||
description="Tag types allow you to group tags together in the management UI"
|
||||
documentationLink="https://docs.getunleash.io/advanced/tags"
|
||||
documentationLinkLabel="Tags documentation"
|
||||
formatApiCode={formatApiCode}
|
||||
>
|
||||
<TagTypeForm
|
||||
|
||||
@ -61,6 +61,7 @@ const EditTagType = () => {
|
||||
title="Edit tag type"
|
||||
description="Tag types allow you to group tags together in the management UI"
|
||||
documentationLink="https://docs.getunleash.io/"
|
||||
documentationLinkLabel="Tags documentation"
|
||||
formatApiCode={formatApiCode}
|
||||
>
|
||||
<TagForm
|
||||
|
||||
Loading…
Reference in New Issue
Block a user