chore: reorganize docs apps (#7228)

* reorganize docs apps * add README * fix directory * add condition for old docs
2024-05-03 17:36:38 +03:00
parent 224ebb2154
commit 4fe28f5a95
6187 changed files with 601447 additions and 598226 deletions
@@ -0,0 +1,89 @@
+---
+sidebar_position: 1
+---
+
+import { SquareTwoStack, EllipsisHorizontal } from "@medusajs/icons"
+
+export const metadata = {
+  title: `API Key Management`,
+}
+
+# {metadata.title}
+
+In this document, you’ll learn how to manage publishable API keys in the Medusa Admin.
+
+## What is a Publishable API Key
+
+Publishable API key define resources associated with a public API key. This API key is used by developers when developing a storefront.
+
+Currently, publishable API keys are only associated with sales channels.
+
+---
+
+## Create a Publishable API Key
+
+To create a publishable API key:
+
+1. Go to Settings → API key management.
+2. Click on the Create button at the top right.
+3. In the new form that opens, enter the title of the API key.
+4. Click the Save button.
+
+---
+
+## Copy Token of Publishable API Key
+
+To copy the token of an API key:
+
+1. Go to Settings → API key management.
+2. Find the API key you want to copy.
+3. Click the <InlineIcon Icon={SquareTwoStack} alt="copy" /> icon in the Key column of the API key.
+
+---
+
+## Edit Publishable API Key Details
+
+To edit the details of an API key:
+
+1. Go to Settings → API key management.
+2. Find the publishable API key in the list and click on it.
+3. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
+4. Choose Edit from the dropdown.
+5. In the drawer that opens, edit the publishable API key's details.
+6. Once you're done, click the Save button.
+
+---
+
+## Revoke Publishable API Key
+
+<Note type="warning">
+
+Revoking a publishable API key is irreversible.
+
+</Note>
+
+To revoke a publishable API key:
+
+1. Go to Settings → API key management.
+2. Find the publishable API key in the list and click on it.
+3. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
+4. Choose Revoke from the dropdown.
+5. Confirm revoking the publishable API key by clicking the Revoke button in the pop-up.
+
+---
+
+## Delete Publishable API Key
+
+<Note type="warning">
+
+Deleting a publishable API key is irreversible.
+
+</Note>
+
+To delete a publishable API key:
+
+1. Go to Settings → API key management.
+2. Find the publishable API key in the list and click on it.
+3. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
+4. Choose Delete from the dropdown.
+5. Confirm deleting the publishable API key by clicking the Delete button in the pop-up.
@@ -0,0 +1,34 @@
+---
+sidebar_position: 1
+sidebar_label: "Manage Sales Channels"
+---
+
+export const metadata = {
+  title: `Manage Sales Channels of a Publishable API Key`,
+}
+
+# {metadata.title}
+
+In this document, you'll learn how to manage the sales channels of a publishable API key.
+
+## Add Sales Channels
+
+To add sales channels to a publishable API key:
+
+1. Go to Settings → API key management.
+2. Find the publishable API key in the list and click on it.
+3. Under the Sales Channels section, click the Add button.
+4. In the list that opens, check the checkbox next the sales channels to add.
+5. Once you're done, click the Save button.
+
+---
+
+## Remove Sales Channels
+
+To remove sales channels from a publishable API key:
+
+1. Go to Settings → API key management.
+2. Find the publishable API key in the list and click on it.
+3. Under the Sales Channels section, check the checkbox next to the sales channels you want to remove.
+4. Once you're done, press <Kbd>R</Kbd>
+5. Confirm deleting the sales channel by clicking the Delete button in the pop-up.
@@ -0,0 +1,57 @@
+---
+sidebar_position: 2
+sidebar_label: "Executions"
+---
+
+import { ArrowsPointingOut } from "@medusajs/icons"
+
+export const metadata = {
+  title: `View Executions`,
+}
+
+# {metadata.title}
+
+In this documentation, you'll learn how to view executions in your store and their details.
+
+## What is an Execution?
+
+An execution refers to a workflow that's been executed. You can view a workflow execution's progress, details, and raw JSON data all from the Medusa Admin.
+
+---
+
+## View Executions
+
+To view all workflow executions, go to Settings → Executions. You'll find a list of executions with general details.
+
+---
+
+## View Execution Details
+
+To view an execution's details:
+
+1. Go to Settings → Executions.
+2. Click on the execution to view it.
+
+On the execution's page, you'll find multiple sections with the execution's details.
+
+### Summary Section
+
+In the first section, you'll find a summary of the execution, including its status, workflow ID, transaction ID, and progress.
+
+### Timeline
+
+The timeline diagram shows you the execution step by step. You can zoom in and pan to view the entire diagram.
+
+If you click on a step, you'll be shown the details in the History section.
+
+### History
+
+The History section shows you the execution of the steps in a linear path.
+
+If you click on a step, you'll see its definition, output, and compensation input.
+
+For a failed step, you'll see the error that occurred.
+
+### JSON
+
+The JSON section allows you to see view the execution's details as a raw JSON by clicking the <InlineIcon Icon={ArrowsPointingOut} alt="expand" /> icon.
@@ -0,0 +1,19 @@
+---
+sidebar_position: 9
+sidebar_label: "Developer"
+---
+
+export const metadata = {
+  title: `Developer Settings`,
+}
+
+# {metadata.title}
+
+The Developer section in the settings allows you to manage developer-related settings, such as API key managements or executions.
+
+---
+
+## Learn More about Developer Settings
+
+- [API Key Management](./api-key-management/page.mdx)
+- [Executions](./executions/page.mdx)