1
0
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 2022-04-25 09:36:23 +02:00 committed by GitHub
parent 984e75a03b
commit 1fd6f2a60a
22 changed files with 32 additions and 10 deletions

View File

@ -78,7 +78,8 @@ export const CreateApiToken = () => {
loading={loading} loading={loading}
title="Create Api Token" 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." 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} formatApiCode={formatApiCode}
> >
<ApiTokenForm <ApiTokenForm

View File

@ -76,7 +76,8 @@ const CreateProjectRole = () => {
description="A project role can be description="A project role can be
customised to limit access customised to limit access
to resources within a project" 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} formatApiCode={formatApiCode}
> >
<ProjectRoleForm <ProjectRoleForm

View File

@ -104,7 +104,8 @@ const EditProjectRole = () => {
description="A project role can be description="A project role can be
customised to limit access customised to limit access
to resources within a project" 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} formatApiCode={formatApiCode}
> >
<ProjectRoleForm <ProjectRoleForm

View File

@ -81,7 +81,8 @@ const CreateUser = () => {
title="Create Unleash user" title="Create Unleash user"
description="In order to get access to Unleash needs to have an Unleash root role as Admin, Editor or Viewer. 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." 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} formatApiCode={formatApiCode}
> >
<UserForm <UserForm

View File

@ -77,7 +77,8 @@ const EditUser = () => {
title="Edit user" title="Edit user"
description="In order to get access to Unleash needs to have an Unleash root role as Admin, Editor or Viewer. 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." 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} formatApiCode={formatApiCode}
> >
<UserForm <UserForm

View File

@ -21,7 +21,7 @@ interface ICreateProps {
title: string; title: string;
description: string; description: string;
documentationLink: string; documentationLink: string;
documentationLinkLabel?: string; documentationLinkLabel: string;
loading?: boolean; loading?: boolean;
modal?: boolean; modal?: boolean;
formatApiCode: () => string; formatApiCode: () => string;

View File

@ -77,7 +77,8 @@ export const CreateUnleashContext = ({
title="Create context" title="Create context"
description="Context fields are a basic building block used in Unleash to control roll-out. 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." 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} formatApiCode={formatApiCode}
modal={modal} modal={modal}
> >

View File

@ -79,7 +79,8 @@ export const EditContext = () => {
title="Edit context" title="Edit context"
description="Context fields are a basic building block used in Unleash to control roll-out. 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." 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} formatApiCode={formatApiCode}
> >
<ContextForm <ContextForm

View File

@ -87,6 +87,7 @@ const CreateEnvironment = () => {
enabling the feature toggle in the enabling the feature toggle in the
production environment." production environment."
documentationLink="https://docs.getunleash.io/user_guide/environments" documentationLink="https://docs.getunleash.io/user_guide/environments"
documentationLinkLabel="Environments documentation"
formatApiCode={formatApiCode} formatApiCode={formatApiCode}
> >
<EnvironmentForm <EnvironmentForm

View File

@ -73,6 +73,7 @@ const EditEnvironment = () => {
enabling the feature toggle in the enabling the feature toggle in the
production environment." production environment."
documentationLink="https://docs.getunleash.io/user_guide/environments" documentationLink="https://docs.getunleash.io/user_guide/environments"
documentationLinkLabel="Environments documentation"
formatApiCode={formatApiCode} formatApiCode={formatApiCode}
> >
<EnvironmentForm <EnvironmentForm

View File

@ -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. 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" The feature toggle is disabled when created and you decide when to enable"
documentationLink="https://docs.getunleash.io/advanced/feature_toggle_types" documentationLink="https://docs.getunleash.io/advanced/feature_toggle_types"
documentationLinkLabel="Feature toggle types documentation"
formatApiCode={formatApiCode} formatApiCode={formatApiCode}
> >
<FeatureForm <FeatureForm

View File

@ -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. 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" The feature toggle is disabled when created and you decide when to enable"
documentationLink="https://docs.getunleash.io/advanced/feature_toggle_types" documentationLink="https://docs.getunleash.io/advanced/feature_toggle_types"
documentationLinkLabel="Feature toggle types documentation"
formatApiCode={formatApiCode} formatApiCode={formatApiCode}
> >
<FeatureForm <FeatureForm

View File

@ -15,6 +15,7 @@ import {
featureStrategyHelp, featureStrategyHelp,
formatFeaturePath, formatFeaturePath,
createStrategyPayload, createStrategyPayload,
featureStrategyDocsLinkLabel,
} from '../FeatureStrategyEdit/FeatureStrategyEdit'; } from '../FeatureStrategyEdit/FeatureStrategyEdit';
import { getStrategyObject } from 'utils/getStrategyObject'; import { getStrategyObject } from 'utils/getStrategyObject';
import { useStrategies } from 'hooks/api/getters/useStrategies/useStrategies'; import { useStrategies } from 'hooks/api/getters/useStrategies/useStrategies';
@ -79,6 +80,7 @@ export const FeatureStrategyCreate = () => {
title={formatStrategyName(strategyName)} title={formatStrategyName(strategyName)}
description={featureStrategyHelp} description={featureStrategyHelp}
documentationLink={featureStrategyDocsLink} documentationLink={featureStrategyDocsLink}
documentationLinkLabel={featureStrategyDocsLinkLabel}
formatApiCode={() => formatApiCode={() =>
formatAddStrategyApiCode( formatAddStrategyApiCode(
projectId, projectId,

View File

@ -90,6 +90,7 @@ export const FeatureStrategyEdit = () => {
title={formatStrategyName(strategy.name ?? '')} title={formatStrategyName(strategy.name ?? '')}
description={featureStrategyHelp} description={featureStrategyHelp}
documentationLink={featureStrategyDocsLink} documentationLink={featureStrategyDocsLink}
documentationLinkLabel={featureStrategyDocsLinkLabel}
formatApiCode={() => formatApiCode={() =>
formatUpdateStrategyApiCode( formatUpdateStrategyApiCode(
projectId, projectId,
@ -170,3 +171,5 @@ export const featureStrategyHelp = `
export const featureStrategyDocsLink = export const featureStrategyDocsLink =
'https://docs.getunleash.io/user_guide/activation_strategy'; 'https://docs.getunleash.io/user_guide/activation_strategy';
export const featureStrategyDocsLinkLabel = 'Strategies documentation';

View File

@ -74,6 +74,7 @@ const CreateProject = () => {
title="Create project" title="Create project"
description="Projects allows you to group feature toggles together in the management UI." description="Projects allows you to group feature toggles together in the management UI."
documentationLink="https://docs.getunleash.io/user_guide/projects" documentationLink="https://docs.getunleash.io/user_guide/projects"
documentationLinkLabel="Projects documentation"
formatApiCode={formatApiCode} formatApiCode={formatApiCode}
> >
<ProjectForm <ProjectForm

View File

@ -73,6 +73,7 @@ const EditProject = () => {
title="Edit project" title="Edit project"
description="Projects allows you to group feature toggles together in the management UI." description="Projects allows you to group feature toggles together in the management UI."
documentationLink="https://docs.getunleash.io/user_guide/projects" documentationLink="https://docs.getunleash.io/user_guide/projects"
documentationLinkLabel="Projects documentation"
formatApiCode={formatApiCode} formatApiCode={formatApiCode}
> >
<ProjectForm <ProjectForm

View File

@ -78,7 +78,7 @@ export const CreateSegment = () => {
title="Create segment" title="Create segment"
description={segmentsFormDescription} description={segmentsFormDescription}
documentationLink={segmentsDocsLink} documentationLink={segmentsDocsLink}
documentationLinkLabel="More about segments" documentationLinkLabel="Segments documentation"
formatApiCode={formatApiCode} formatApiCode={formatApiCode}
> >
<SegmentForm <SegmentForm

View File

@ -81,7 +81,7 @@ export const EditSegment = () => {
title="Edit segment" title="Edit segment"
description={segmentsFormDescription} description={segmentsFormDescription}
documentationLink={segmentsDocsLink} documentationLink={segmentsDocsLink}
documentationLinkLabel="More about segments" documentationLinkLabel="Segments documentation"
formatApiCode={formatApiCode} formatApiCode={formatApiCode}
> >
<SegmentForm <SegmentForm

View File

@ -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. 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" 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" documentationLink="https://docs.getunleash.io/advanced/custom_activation_strategy"
documentationLinkLabel="Custom strategies documentation"
formatApiCode={formatApiCode} formatApiCode={formatApiCode}
> >
<StrategyForm <StrategyForm

View File

@ -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. 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" 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" documentationLink="https://docs.getunleash.io/advanced/custom_activation_strategy"
documentationLinkLabel="Custom strategies documentation"
formatApiCode={formatApiCode} formatApiCode={formatApiCode}
> >
<StrategyForm <StrategyForm

View File

@ -64,6 +64,7 @@ const CreateTagType = () => {
title="Create tag type" title="Create tag type"
description="Tag types allow you to group tags together in the management UI" description="Tag types allow you to group tags together in the management UI"
documentationLink="https://docs.getunleash.io/advanced/tags" documentationLink="https://docs.getunleash.io/advanced/tags"
documentationLinkLabel="Tags documentation"
formatApiCode={formatApiCode} formatApiCode={formatApiCode}
> >
<TagTypeForm <TagTypeForm

View File

@ -61,6 +61,7 @@ const EditTagType = () => {
title="Edit tag type" title="Edit tag type"
description="Tag types allow you to group tags together in the management UI" description="Tag types allow you to group tags together in the management UI"
documentationLink="https://docs.getunleash.io/" documentationLink="https://docs.getunleash.io/"
documentationLinkLabel="Tags documentation"
formatApiCode={formatApiCode} formatApiCode={formatApiCode}
> >
<TagForm <TagForm