From 3ced5e10d21a81e6050cad14f936b2c2bad04e33 Mon Sep 17 00:00:00 2001 From: Tyler Ohlsen Date: Fri, 6 Oct 2023 17:09:57 -0700 Subject: [PATCH] Rename; add some comments Signed-off-by: Tyler Ohlsen --- public/pages/overview/overview.tsx | 8 ++++++++ public/pages/workflow_detail/workflow_detail.tsx | 5 +++++ .../pages/workflow_detail/workspace/component_details.tsx | 5 +++++ .../workflow_detail/workspace/resizable_workspace.tsx | 4 ++++ public/pages/workflows/new_workflow/new_workflow.tsx | 7 +++++++ public/pages/workflows/workflow_list/workflow_list.tsx | 3 +++ public/pages/workflows/workflows.tsx | 5 +++++ 7 files changed, 37 insertions(+) diff --git a/public/pages/overview/overview.tsx b/public/pages/overview/overview.tsx index d352297e..3043bacc 100644 --- a/public/pages/overview/overview.tsx +++ b/public/pages/overview/overview.tsx @@ -14,6 +14,14 @@ import { import { BREADCRUMBS } from '../../utils'; import { getCore } from '../../services'; +/** + * The overview page. This contains a detailed description on what + * this plugin offers, and links to different resources (blogs, demos, + * documentation, etc.) + * + * This may be hidden for the initial release until we have sufficient content + * such that this page adds enough utility & user value. + */ export function Overview() { useEffect(() => { getCore().chrome.setBreadcrumbs([ diff --git a/public/pages/workflow_detail/workflow_detail.tsx b/public/pages/workflow_detail/workflow_detail.tsx index 6190a034..f8ecc1f3 100644 --- a/public/pages/workflow_detail/workflow_detail.tsx +++ b/public/pages/workflow_detail/workflow_detail.tsx @@ -20,6 +20,11 @@ export interface WorkflowDetailRouterProps { interface WorkflowDetailProps extends RouteComponentProps {} +/** + * The workflow details page. This is where users will configure, create, and + * test their created workflows. Additionally, can be used to load existing workflows + * to view details and/or make changes to them. + */ export function WorkflowDetail(props: WorkflowDetailProps) { const { workflows } = useSelector((state: AppState) => state.workflows); diff --git a/public/pages/workflow_detail/workspace/component_details.tsx b/public/pages/workflow_detail/workspace/component_details.tsx index 8f249c8c..b9784e18 100644 --- a/public/pages/workflow_detail/workspace/component_details.tsx +++ b/public/pages/workflow_detail/workspace/component_details.tsx @@ -26,6 +26,11 @@ interface ComponentDetailsProps { isOpen: boolean; } +/** + * A panel that will be nested in a resizable container to dynamically show + * the details and user-required inputs based on the selected component + * in the flow workspace. + */ export function ComponentDetails(props: ComponentDetailsProps) { // TODO: use this instance to update the internal node state. ex: update field data in the selected node based // on user input diff --git a/public/pages/workflow_detail/workspace/resizable_workspace.tsx b/public/pages/workflow_detail/workspace/resizable_workspace.tsx index c2fcc698..a62212a6 100644 --- a/public/pages/workflow_detail/workspace/resizable_workspace.tsx +++ b/public/pages/workflow_detail/workspace/resizable_workspace.tsx @@ -14,6 +14,10 @@ interface ResizableWorkspaceProps { workflow?: Workflow; } +/** + * The overall workspace component that maintains state related to the 2 resizable + * panels - the ReactFlow workspace panel and the selected component details panel. + */ export function ResizableWorkspace(props: ResizableWorkspaceProps) { const [isOpen, setIsOpen] = useState(true); const collapseFn = useRef( diff --git a/public/pages/workflows/new_workflow/new_workflow.tsx b/public/pages/workflows/new_workflow/new_workflow.tsx index 580c7a6d..ce87c443 100644 --- a/public/pages/workflows/new_workflow/new_workflow.tsx +++ b/public/pages/workflows/new_workflow/new_workflow.tsx @@ -10,6 +10,13 @@ import { UseCase } from './use_case'; interface NewWorkflowProps {} +/** + * TODO: may rename this later on. + * + * Contains the searchable library of templated workflows based + * on a variety of use cases. Can click on them to load in a pre-configured + * workflow for users to start with. + */ export function NewWorkflow(props: NewWorkflowProps) { return ( diff --git a/public/pages/workflows/workflow_list/workflow_list.tsx b/public/pages/workflows/workflow_list/workflow_list.tsx index f182de24..005eb6e3 100644 --- a/public/pages/workflows/workflow_list/workflow_list.tsx +++ b/public/pages/workflows/workflow_list/workflow_list.tsx @@ -12,6 +12,9 @@ import { columns } from './columns'; interface WorkflowListProps {} +/** + * The searchable list of created workflows. + */ export function WorkflowList(props: WorkflowListProps) { const { workflows } = useSelector((state: AppState) => state.workflows); diff --git a/public/pages/workflows/workflows.tsx b/public/pages/workflows/workflows.tsx index c79a8736..0b3c4649 100644 --- a/public/pages/workflows/workflows.tsx +++ b/public/pages/workflows/workflows.tsx @@ -41,6 +41,11 @@ function replaceActiveTab(activeTab: string, props: WorkflowsProps) { }); } +/** + * The base workflows page. From here, users can toggle between views to access + * existing created workflows, or explore the library of workflow templates + * to get started on a new workflow. + */ export function Workflows(props: WorkflowsProps) { const { workflows } = useSelector((state: AppState) => state.workflows);