mirror of
https://github.com/Unleash/unleash.git
synced 2025-09-24 17:51:14 +02:00
## What This (admittedly massive) PR updates the "physical" documentation structure and fixes url inconsistencies and SEO problems reported by marketing. The main points are: - remove or move directories : advanced, user_guide, deploy, api - move the files contained within to the appropriate one of topics, how-to, tutorials, or reference - update internal doc links and product links to the content - create client-side redirects for all the urls that have changed. A number of the files have been renamed in small ways to better match their url and to make them easier to find. Additionally, the top-level api directory has been moved to /reference/api/legacy/unleash (see the discussion points section for more on this). ## Why When moving our doc structure to diataxis a while back, we left the "physical' files lying where they were, because it didn't matter much to the new structure. However, that did introduce some inconsistencies with where you place docs and how we organize them. There's also the discrepancies in whether urls us underscores or hyphens (which isn't necessarily the same as their file name), which has been annoying me for a while, but now has also been raised by marketing as an issue in terms of SEO. ## Discussion points The old, hand-written API docs have been moved from /api to /reference/api/legacy/unleash. There _is_ a /reference/api/unleash directory, but this is being populated by the OpenAPI plugin, and mixing those could only cause trouble. However, I'm unsure about putting /legacy/ in the title, because the API isn't legacy, the docs are. Maybe we could use another path? Like /old-docs/ or something? I'd appreciate some input on this.
110 lines
3.8 KiB
TypeScript
110 lines
3.8 KiB
TypeScript
import { CreateButton } from 'component/common/CreateButton/CreateButton';
|
|
import FormTemplate from 'component/common/FormTemplate/FormTemplate';
|
|
import { useContextForm } from '../hooks/useContextForm';
|
|
import { ContextForm } from '../ContextForm/ContextForm';
|
|
import { CREATE_CONTEXT_FIELD } from 'component/providers/AccessProvider/permissions';
|
|
import useContextsApi from 'hooks/api/actions/useContextsApi/useContextsApi';
|
|
import useUiConfig from 'hooks/api/getters/useUiConfig/useUiConfig';
|
|
import useUnleashContext from 'hooks/api/getters/useUnleashContext/useUnleashContext';
|
|
import useToast from 'hooks/useToast';
|
|
import { formatUnknownError } from 'utils/formatUnknownError';
|
|
|
|
interface ICreateContextProps {
|
|
onSubmit: () => void;
|
|
onCancel: () => void;
|
|
modal?: boolean;
|
|
}
|
|
|
|
export const CreateUnleashContext = ({
|
|
onSubmit,
|
|
onCancel,
|
|
modal,
|
|
}: ICreateContextProps) => {
|
|
const { setToastData, setToastApiError } = useToast();
|
|
const { uiConfig } = useUiConfig();
|
|
const {
|
|
contextName,
|
|
contextDesc,
|
|
legalValues,
|
|
stickiness,
|
|
setContextName,
|
|
setContextDesc,
|
|
setLegalValues,
|
|
setStickiness,
|
|
getContextPayload,
|
|
validateContext,
|
|
clearErrors,
|
|
setErrors,
|
|
errors,
|
|
} = useContextForm();
|
|
const { createContext, loading } = useContextsApi();
|
|
const { refetchUnleashContext } = useUnleashContext();
|
|
|
|
const handleSubmit = async (e: Event) => {
|
|
e.preventDefault();
|
|
e.stopPropagation();
|
|
const validName = await validateContext();
|
|
|
|
if (validName) {
|
|
const payload = getContextPayload();
|
|
try {
|
|
await createContext(payload);
|
|
refetchUnleashContext();
|
|
setToastData({
|
|
title: 'Context created',
|
|
confetti: true,
|
|
type: 'success',
|
|
});
|
|
onSubmit();
|
|
} catch (error: unknown) {
|
|
setToastApiError(formatUnknownError(error));
|
|
}
|
|
}
|
|
};
|
|
|
|
const formatApiCode = () => {
|
|
return `curl --location --request POST '${
|
|
uiConfig.unleashUrl
|
|
}/api/admin/context' \\
|
|
--header 'Authorization: INSERT_API_KEY' \\
|
|
--header 'Content-Type: application/json' \\
|
|
--data-raw '${JSON.stringify(getContextPayload(), undefined, 2)}'`;
|
|
};
|
|
|
|
return (
|
|
<FormTemplate
|
|
loading={loading}
|
|
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/reference/unleash-context#custom-context-fields"
|
|
documentationLinkLabel="Context fields documentation"
|
|
formatApiCode={formatApiCode}
|
|
modal={modal}
|
|
>
|
|
<ContextForm
|
|
errors={errors}
|
|
handleSubmit={handleSubmit}
|
|
onCancel={onCancel}
|
|
contextName={contextName}
|
|
setContextName={setContextName}
|
|
contextDesc={contextDesc}
|
|
setContextDesc={setContextDesc}
|
|
legalValues={legalValues}
|
|
setLegalValues={setLegalValues}
|
|
stickiness={stickiness}
|
|
setStickiness={setStickiness}
|
|
mode="Create"
|
|
validateContext={validateContext}
|
|
setErrors={setErrors}
|
|
clearErrors={clearErrors}
|
|
>
|
|
<CreateButton
|
|
name="context"
|
|
permission={CREATE_CONTEXT_FIELD}
|
|
/>
|
|
</ContextForm>
|
|
</FormTemplate>
|
|
);
|
|
};
|