@patternfly/quickstarts 2.0.1 → 2.2.1

package/README.md

@@ -99,7 +99,7 @@ const App = () => {
     setTimeout(() => {
       // simulate loading time to get the quick starts from somewhere
       load();
-    }, 1500);
+    }, 500);
   }, []);
 
   const withQueryParams = true;
@@ -166,38 +166,17 @@ See above usage of `useLegacyHeaderColors` boolean to opt-out of update. Should
 
 ## Quick starts format
 
-Quick starts are parsed as markdown. To write your own quick start, if you use Typescript you can [check out the type definition here](https://github.com/patternfly/patternfly-quickstarts/blob/d52b194119f1ff16e69bf589d49a14931a19ac4b/packages/module/src/utils/quick-start-types.ts#L6).
-
-A basic quick start has this structure:
-```yaml
-metadata:
-  name: id-of-this-quick-start
-spec:
-  displayName: Get started with Node
-  durationMinutes: 10
-  description: 'Import a Node Application from git, build, and deploy it onto OpenShift.'
-  introduction: >-
-    **Node.js** is based on the V8 JavaScript engine and allows you to write
-    server-side JavaScript applications. It provides an I/O model based on
-    events and non-blocking operations that enables you to write efficient
-    applications.
-  tasks:
-    - title: Create a Node application
-      description: First task description
-      review:
-        failedTaskHelp: This task isn’t verified yet. Try the task again.
-        instructions: >-
-          The application is represented by the light grey area with the white border. The deployment is a white circle. Verify that the application was successfully created.
-    - title: View the build status
-      description: Second task description
-      review:
-        failedTaskHelp: This task isn’t verified yet. Try the task again.
-        instructions: >-
-          This build may take a few minutes. When it's finished, a **Complete** badge will surface on the page header beside build name **nodejsrest-http-redhat-1**. Did this badge appear?
-  conclusion: Your Node application is deployed and ready.
-```
-
-For more examples of quick starts, [you can go here](https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/dev/src/quickstarts-data/mocks/yamls).
+Quick starts are parsed as markdown. To write your own quick start, if you use Typescript you can [check out the type definition here](https://github.com/patternfly/patternfly-quickstarts/blob/main/packages/module/src/utils/quick-start-types.ts).
+
+Here's a [yaml template](https://github.com/patternfly/patternfly-quickstarts/blob/main/packages/dev/src/quickstarts-data/yaml/template.yaml) to get you started on writing your own quick starts.
+
+## Writing quick starts
+
+Quick starts are typically written in yaml, but we've also seen projects use asciidoc and json. As long as you can pass in an [array of quick starts](https://github.com/patternfly/patternfly-quickstarts/blob/b086faefb0699e4259ca23d058ed330df1d87f8a/packages/module/src/QuickStartDrawer.tsx#L18) it doesn't really matter in what format your content is sourced.
+- We have a [yaml starter template here](https://github.com/patternfly/patternfly-quickstarts/blob/main/packages/dev/src/quickstarts-data/yaml/template.yaml)
+- The easiest way to preview the content as you're writing it, is to use Visual Studio code with our [quickstarts-preview extension](https://marketplace.visualstudio.com/items?itemName=PatternFly.quickstarts-preview).
+  - Alternatively, you can use [github.dev](https://github.dev/) which is basically VS Code on the web, and install the extension there, then edit your yaml content!
+- For guidelines on writing a quick start, the fine folks at OpenShift have created [this guide](https://docs.openshift.com/container-platform/4.9/web_console/creating-quick-start-tutorials.html)
 
 ### Highlighting elements
 
@@ -228,6 +207,30 @@ You can have inline or block copyable text.
     ```{{copy}}
 ```
 
+## Markdown extensions
+If your source material content is defined in markdown (yaml + markdown / json + markdown), then you can add your own markdown extensions, example:
+```
+const drawerProps: QuickStartContainerProps = {
+  markdown: {
+    extensions: [
+      // variable substitution example
+      // this replaces the strings [APPLICATION] and [PRODUCT]
+      {
+        type: 'output',
+        filter: function(html: string) {
+          html = html.replace(/\[APPLICATION\]/g, 'Mercury');
+          html = html.replace(/\[PRODUCT\]/g, 'Lightning');
+
+          return html;
+        },
+      },
+    ],
+  },
+};
+
+return <QuickStartContainer {...drawerProps}>My page content</QuickStartContainer>
+```
+
 ## Localization
 We use English as the default language. You can override the default by providing your own key/value pairs to the `QuickStartContainer` or `QuickStartContextProvider` resourceBundle prop.
 
@@ -250,4 +253,285 @@ return (
 Use this [file](https://github.com/patternfly/patternfly-quickstarts/blob/main/packages/module/src/locales/en/quickstart.json) as a base for your translations.
 Each language is different, especially when it comes to plurals. Try [this utility](https://jsfiddle.net/6bpxsgd4) sourced from [i18next](https://www.i18next.com/translation-function/plurals#how-to-find-the-correct-plural-suffix) to determine the suffixes for the right plural format.
 
-#### 
+For localizing the content of quick starts files, we provide the option to include `language` and `countryCode` key to your translated file. Based on these keys you can filter out quick starts. We have a demo of this behaviour in our [demo app](https://quickstarts.netlify.app/quickstarts-localized). You can have a look at the code [here](https://github.com/patternfly/patternfly-quickstarts/blob/main/packages/dev/src/AppLocalized.tsx).
+
+## In-App / In Context Help Panel
+
+The quickstarts package is being extended to support a side panel that displays smaller chunks (defined as the `HelpTopic` type) of documentation.
+
+### Help Topic type definition
+
+```ts
+type HelpTopic = {
+  name: string; // unique identifier
+  title: string; // displayed in header of side panel
+  tags: string[]; // metadata to filter/add relationships between HelpTopics and some piece of data in your application
+  content: string; // main content of topic, supports markdown
+  links: string[]; // list of related information, use markdown link syntax
+};
+```
+
+### Example Help Topic in yaml with markdown support for content and links
+
+```yml
+- name: auto-deploy
+  tags:
+    - page-1
+  title: Automatic Deployment
+  content: |-
+    **An Automatic Deployment** is...
+
+    Etiam viverra et tortor et maximus. Aliquam quis scelerisque metus. Proin luctus pretium sodales. Mauris nibh nibh, auctor eu scelerisque et, hendrerit a metus. Vivamus pharetra bibendum finibus. Sed a pulvinar ipsum. Fusce pharetra venenatis porttitor. Praesent justo metus, consectetur quis erat id, congue varius metus. Suspendisse dui est, tempor nec diam quis, facilisis sodales erat. Curabitur viverra convallis ex. Ut egestas condimentum augue, id euismod leo volutpat vitae. Quisque aliquet ac dolor quis pretium. Nunc at nibh quis arcu maximus elementum vel a mi.
+  links:
+    - '[Creating quick starts](https://docs.openshift.com/container-platform/4.9/web_console/creating-quick-start-tutorials.html)'
+    - '[Redhat Console](https://console.redhat.com/)'
+- name: workspace
+  tags:
+    - page-1
+    - page-2
+    - page-3
+  title: Workspace
+  content: |-
+    **A Workspace** is...
+
+    Fusce nunc risus, vehicula feugiat pellentesque sit amet, pretium non urna. Phasellus nibh mi, ornare quis euismod a, iaculis et eros. Vivamus auctor nunc odio, quis porttitor diam pellentesque nec. In et varius tellus, eget porta urna. Etiam bibendum, est eget mollis lobortis, velit risus efficitur lacus, sed pulvinar sem est vel libero. In sodales placerat tincidunt. Proin vitae risus elit. Ut lobortis ligula est, cursus rhoncus enim scelerisque ac. Donec lacus nisl, tempor porta hendrerit nec, volutpat vitae arcu. Curabitur ornare ullamcorper mi in tincidunt. Aenean efficitur posuere auctor. Pellentesque accumsan mauris vel arcu congue, nec sagittis nisl condimentum. Suspendisse mauris nulla, dignissim at viverra sed, fringilla eu purus.
+  links:
+    - '[Creating quick starts](https://docs.openshift.com/container-platform/4.9/web_console/creating-quick-start-tutorials.html)'
+    - '[Redhat Console](https://console.redhat.com/)'
+```
+
+### Usage Example
+
+See the [HelpTopicDemo](https://github.com/patternfly/patternfly-quickstarts/blob/6b35d3c346b3e92ed0003de955421c8dff58a22b/packages/dev/src/AppHelpTopicDemo.tsx)
+
+- Similar to standard Quickstarts usage
+- Load yaml defined `HelpTopic` array
+- Pass `HelpTopicContainerProps`, including loaded `HelpTopics` to the `<HelpTopicContainer/>`
+
+```tsx
+import './App.css';
+import { Page } from '@patternfly/react-core';
+import { LoadingBox, HelpTopicContainerProps, HelpTopicContainer } from '@patternfly/quickstarts';
+import { helpTopics } from './quickstarts-data/quick-start-test-data';
+import React from 'react';
+import i18n from './i18n/i18n';
+import { AppHeader, AppSidebar } from './common/Page';
+
+type AppProps = {
+  children?: React.ReactNode;
+  showCardFooters?: boolean;
+};
+
+const AppHelpTopicDemo: React.FC<AppProps> = ({ children }) => {
+  const language = localStorage.getItem('bridge/language') || 'en';
+  const resourceBundle = i18n.getResourceBundle(language, 'quickstart');
+
+  const [loading, setLoading] = React.useState(true);
+  React.useEffect(() => {
+    const load = async () => {
+      setLoading(false);
+    };
+    setTimeout(() => {
+      load();
+    }, 500);
+  }, []);
+
+  const inContextHelpProps: HelpTopicContainerProps = {
+    helpTopics,
+    resourceBundle,
+    language,
+    loading,
+  };
+
+  return (
+    <React.Suspense fallback={<LoadingBox />}>
+      <HelpTopicContainer {...inContextHelpProps}>
+        <Page header={AppHeader} sidebar={AppSidebar} isManagedSidebar>
+          {children}
+        </Page>
+      </HelpTopicContainer>
+    </React.Suspense>
+  );
+};
+```
+
+In the example above `<HelpTopicContainer />` wraps the `<Page/>` element as well as a mock "console" showing how to trigger the side panel and allow navigation to all `HelpTopics` available on each console page:
+
+Live [preview](https://deploy-preview-140--quickstarts.netlify.app/in-context-help) of code below:
+
+```tsx
+import * as React from 'react';
+import {
+  Banner,
+  Button,
+  Divider,
+  Form,
+  FormGroup,
+  PageSection,
+  Popover,
+  Split,
+  SplitItem,
+  TextInput,
+  Title,
+} from '@patternfly/react-core';
+import { HelpTopicContext, HelpTopicContextValues } from '@patternfly/quickstarts';
+import HelpIcon from '@patternfly/react-icons/dist/js/icons/help-icon';
+import { HelpTopic } from '@patternfly/quickstarts/dist/utils/help-topic-types';
+
+// Example usage of topics, render certain topics depending on the page
+// used this case when "consolePageState" below is between 4 - 6
+// these HelpTopics with the following names will be rendered
+const helpTopicNamesByPage = [
+  ['auto-deploy', 'code-sample', 'manual-deployment'],
+  ['manual-deployment', 'target-port', 'build-configuration'],
+  ['deploy-configuration', 'environment-variables', 'health-checks'],
+];
+
+interface FormGroupWithHelpTopicPopoverProps extends React.HTMLProps<HTMLDivElement> {
+  topic: HelpTopic;
+}
+
+// Example usage of setActiveHelpTopicByName()
+// render a popover with a learn more link to open the drawer
+const FormGroupWithHelpTopicPopover: React.FC<FormGroupWithHelpTopicPopoverProps> = ({ topic }) => {
+  const { setActiveHelpTopicByName } = React.useContext<HelpTopicContextValues>(HelpTopicContext);
+
+  return (
+    <FormGroup
+      label={topic.title}
+      isRequired
+      fieldId={topic.name}
+      key={topic.name}
+      labelIcon={
+        <Popover
+          bodyContent={(hide) => (
+            <div>
+              {topic.title} is quite amaizing{' '}
+              <Button
+                variant="link"
+                onClick={() => {
+                  setActiveHelpTopicByName(topic.name);
+                  hide();
+                }}
+              >
+                Learn more
+              </Button>
+            </div>
+          )}
+        >
+          <Button variant="plain">
+            <HelpIcon noVerticalAlign />
+          </Button>
+        </Popover>
+      }
+    >
+      <TextInput isRequired type="text" id={topic.name} />
+    </FormGroup>
+  );
+};
+
+export const MockConsole: React.FC = () => {
+  const { helpTopics, setFilteredHelpTopics, filteredHelpTopics, setActiveHelpTopicByName } =
+    React.useContext<HelpTopicContextValues>(HelpTopicContext);
+
+  // mock console page identifiers: 1 - 6
+  // click handlers to change page
+  const [consolePageState, setConsolePageState] = React.useState(1);
+
+  const handleClickNext = () => {
+    setActiveHelpTopicByName('');
+    if (consolePageState === 6) {
+      setConsolePageState(1);
+      return;
+    }
+    setConsolePageState(consolePageState + 1);
+  };
+
+  const handleClickBack = () => {
+    setActiveHelpTopicByName('');
+    if (consolePageState === 6) {
+      setConsolePageState(4);
+      return;
+    }
+    setConsolePageState(consolePageState - 1);
+  };
+
+  // Example usage setFilteredHelpTopics()
+  // After rendering the console, set the filtered help topics
+  React.useEffect(() => {
+    // set filtered topics using tags, matching to the consolePageState
+    if (consolePageState < 4) {
+      const topics = helpTopics.filter((topic: HelpTopic) => {
+        const pageTagNumbers = topic.tags.map((tag: string) => {
+          return Number(tag.slice(-1));
+        });
+        return pageTagNumbers.includes(consolePageState);
+      });
+      setFilteredHelpTopics(topics);
+    } else {
+      // set filtered topics using the appropriate helpTopicNamesByPage array above
+      setFilteredHelpTopics(
+        helpTopics.filter((topic) => {
+          return helpTopicNamesByPage[consolePageState - 4].includes(topic.name);
+        }),
+      );
+    }
+  }, [consolePageState, helpTopics, setFilteredHelpTopics]);
+
+  // Render filteredHelpTopics in a <FormGroupWithHelpTopicPopover />
+  const formGroupsFromTags = filteredHelpTopics.map((topic: HelpTopic, index) => {
+    return <FormGroupWithHelpTopicPopover topic={topic} key={index} />;
+  });
+
+  // From an array of topic names, render all topics in a <FormGroupWithHelpTopicPopover />
+  const formGroupsFromTopicNames = (helpTopicNames: string[]) => {
+    return helpTopicNames.map((topicName: string, index) => {
+      const topicToRender = helpTopics.find((topic) => {
+        return topicName === topic.name;
+      });
+
+      if (topicToRender) {
+        return <FormGroupWithHelpTopicPopover topic={topicToRender} key={index} />;
+      }
+    });
+  };
+
+  return (
+    <>
+      <PageSection>
+        <Banner variant="info">
+          <Title headingLevel="h1">Console Page {consolePageState}</Title>
+        </Banner>
+      </PageSection>
+      <PageSection>
+        <Title headingLevel="h3">
+          Example usage of help topics opened via popover{' '}
+          <b>
+            {consolePageState < 4
+              ? 'using tags that match the Console Page number'
+              : 'by defining which help topics should be present on each page'}
+          </b>
+        </Title>
+        <Divider />
+        <Form>
+          {consolePageState < 4
+            ? formGroupsFromTags
+            : formGroupsFromTopicNames(helpTopicNamesByPage[consolePageState - 4])}
+        </Form>
+      </PageSection>
+      <PageSection>
+        <Split hasGutter>
+          <SplitItem>
+            <Button onClick={handleClickBack} variant="tertiary">
+              Previous
+            </Button>
+          </SplitItem>
+          <SplitItem>
+            <Button onClick={handleClickNext}>Next</Button>
+          </SplitItem>
+        </Split>
+      </PageSection>
+    </>
+  );
+};
+```

package/dist/ConsoleInternal/module/k8s/types.d.ts

@@ -16,6 +16,7 @@ export declare type OwnerReference = {
     blockOwnerDeletion?: boolean;
 };
 export declare type ObjectMetadata = {
+    name: string;
     annotations?: {
         [key: string]: string;
     };
@@ -30,9 +31,12 @@ export declare type ObjectMetadata = {
         [key: string]: string;
     };
     managedFields?: any[];
-    name?: string;
     namespace?: string;
     ownerReferences?: OwnerReference[];
     resourceVersion?: string;
     uid?: string;
+    language?: string;
+    country?: string;
+    locale?: string;
+    [key: string]: any;
 };

package/dist/ConsoleShared/src/components/markdown-extensions/admonition-extension.d.ts

@@ -0,0 +1,7 @@
+import './showdown-extension.scss';
+declare const useAdmonitionShowdownExtension: () => {
+    type: string;
+    regex: RegExp;
+    replace: (text: string, content: string, admonitionLabel: string, admonitionType: string, groupId: string) => string;
+};
+export default useAdmonitionShowdownExtension;

package/dist/ConsoleShared/src/components/markdown-extensions/index.d.ts

@@ -1,3 +1,4 @@
 export { default as MarkdownCopyClipboard } from './MarkdownCopyClipboard';
 export { default as useInlineCopyClipboardShowdownExtension } from './inline-clipboard-extension';
 export { default as useMultilineCopyClipboardShowdownExtension } from './multiline-clipboard-extension';
+export { default as useAdmonitionShowdownExtension } from './admonition-extension';

package/dist/HelpTopicDrawer.d.ts

@@ -0,0 +1,26 @@
+import './QuickStartDrawer.scss';
+import * as React from 'react';
+import { QuickStartContextValues } from './utils/quick-start-context';
+import { HelpTopic } from './utils/help-topic-types';
+export interface HelpTopicContainerProps extends React.HTMLProps<HTMLDivElement> {
+    helpTopics: HelpTopic[];
+    resourceBundle?: any;
+    language?: string;
+    loading?: boolean;
+    /**
+     * Additional markdown extensions and renderers to use
+     * TODO: example usage - In the meantime you can take a look at:
+     * https://github.com/openshift/console/blob/master/frontend/packages/console-app/src/components/quick-starts/utils/quick-start-context.tsx#L235
+     */
+    markdown?: {
+        extensions?: any[];
+        renderExtension?: (docContext: HTMLDocument, rootSelector: string) => React.ReactNode;
+    };
+    contextProps?: QuickStartContextValues;
+}
+export declare const HelpTopicContainer: React.FC<HelpTopicContainerProps>;
+export interface HelpTopicDrawerProps extends React.HTMLProps<HTMLDivElement> {
+    helpTopics?: HelpTopic[];
+    children?: React.ReactNode;
+}
+export declare const HelpTopicDrawer: React.FC<HelpTopicDrawerProps>;

package/dist/HelpTopicPanelContent.d.ts

@@ -0,0 +1,11 @@
+import * as React from 'react';
+import { HelpTopic } from './utils/help-topic-types';
+import './QuickStartPanelContent.scss';
+declare type HelpTopicPanelContentProps = {
+    activeHelpTopic: HelpTopic;
+    filteredHelpTopics?: HelpTopic[];
+    isResizable?: boolean;
+    onClose: () => void;
+};
+declare const HelpTopicPanelContent: React.FC<HelpTopicPanelContentProps>;
+export default HelpTopicPanelContent;

package/dist/QuickStartCatalogPage.d.ts

@@ -1,6 +1,6 @@
 import * as React from 'react';
 import { QuickStart } from './utils/quick-start-types';
-declare type QuickStartCatalogPageProps = {
+export declare type QuickStartCatalogPageProps = {
     quickStarts?: QuickStart[];
     showFilter?: boolean;
     sortFnc?: (q1: QuickStart, q2: QuickStart) => number;
@@ -12,4 +12,3 @@ export declare const QuickStartCatalogEmptyState: ({ clearFilters }: {
     clearFilters: any;
 }) => JSX.Element;
 export declare const QuickStartCatalogPage: React.FC<QuickStartCatalogPageProps>;
-export {};

package/dist/controller/QuickStartTaskHeader.d.ts

@@ -9,6 +9,7 @@ declare type QuickStartTaskHeaderProps = {
     size?: 'md' | 'lg' | 'xl' | '2xl' | '3xl' | '4xl';
     isActiveTask?: boolean;
     onTaskSelect: (index: number) => void;
+    chidlren?: React.ReactNode;
 };
 declare const QuickStartTaskHeader: React.FC<QuickStartTaskHeaderProps>;
 export default QuickStartTaskHeader;

package/dist/index.d.ts

@@ -3,9 +3,12 @@ export * from './QuickStartCatalogPage';
 export * from './catalog';
 export * from './ConsoleInternal/components/utils';
 export * from './QuickStartDrawer';
+export * from './HelpTopicDrawer';
 export * from './utils/const';
 export * from './utils/quick-start-context';
 export * from './utils/quick-start-types';
+export * from './utils/help-topic-context';
+export * from './utils/help-topic-types';
 export * from './utils/quick-start-utils';
 export * from './utils/useLocalStorage';
 export { default as QuickStartPanelContent } from './QuickStartPanelContent';