Merge pull request instructlab#351 from nerdalert/knowledge-submissio…

…n-wiz Convert standalone knowledge submissions to the new stepped style
nerdalert · Nov 27, 2024 · bd7f46e · bd7f46e
2 parents 68fa485 + 559102b
commit bd7f46e
Show file tree

Hide file tree

Showing 13 changed files with 464 additions and 324 deletions.
diff --git a/src/app/api/local/git/branches/route.ts b/src/app/api/local/git/branches/route.ts
@@ -110,6 +110,13 @@ export async function POST(req: NextRequest) {
       },
       { status: 500 }
     );
+  } finally {
+    // Ensure switching back to 'main' branch after any operation
+    try {
+      await git.checkout({ fs, dir: REPO_DIR, ref: 'main' });
+    } catch (checkoutError) {
+      console.error('Failed to switch back to main branch:', checkoutError);
+    }
   }
 }
 

diff --git a/src/components/Contribute/AuthorInformation.tsx b/src/components/Contribute/AuthorInformation.tsx
@@ -1,5 +1,5 @@
 import React, { useEffect, useState } from 'react';
-import { FormFieldGroupExpandable, FormFieldGroupHeader, FormGroup, FormHelperText } from '@patternfly/react-core/dist/dynamic/components/Form';
+import { FormGroup, FormHelperText } from '@patternfly/react-core/dist/dynamic/components/Form';
 import { TextInput } from '@patternfly/react-core/dist/dynamic/components/TextInput';
 import { HelperText } from '@patternfly/react-core/dist/dynamic/components/HelperText';
 import { HelperTextItem } from '@patternfly/react-core/dist/dynamic/components/HelperText';
@@ -70,23 +70,11 @@ const AuthorInformation: React.FC<Props> = ({ formType, reset, formData, setDisa
   }, [reset]);
 
   return (
-    <FormFieldGroupExpandable
-      isExpanded
-      toggleAriaLabel="Details"
-      header={
-        <FormFieldGroupHeader
-          titleText={{
-            text: (
-              <p>
-                Author Information <span style={{ color: 'red' }}>*</span>
-              </p>
-            ),
-            id: 'author-info-id'
-          }}
-          titleDescription="Provide your information required for a GitHub DCO sign-off."
-        />
-      }
-    >
+    <>
+      <h2>
+        Author Information <span style={{ color: 'red' }}>*</span>
+      </h2>
+      <p>Provide your information required for a GitHub DCO sign-off.</p>
       <FormGroup isRequired key={'author-info-details-email'} label="Email address">
         <TextInput
           isRequired
@@ -129,7 +117,7 @@ const AuthorInformation: React.FC<Props> = ({ formType, reset, formData, setDisa
           </FormHelperText>
         )}
       </FormGroup>
-    </FormFieldGroupExpandable>
+    </>
   );
 };
 

diff --git a/src/components/Contribute/Knowledge/AttributionInformation/AttributionInformation.tsx b/src/components/Contribute/Knowledge/AttributionInformation/AttributionInformation.tsx
@@ -1,5 +1,5 @@
 import React, { useEffect } from 'react';
-import { FormFieldGroupExpandable, FormFieldGroupHeader, FormGroup, FormHelperText } from '@patternfly/react-core/dist/dynamic/components/Form';
+import { FormFieldGroupHeader, FormGroup, FormHelperText } from '@patternfly/react-core/dist/dynamic/components/Form';
 import { TextInput } from '@patternfly/react-core/dist/dynamic/components/TextInput';
 import { HelperText } from '@patternfly/react-core/dist/dynamic/components/HelperText';
 import { HelperTextItem } from '@patternfly/react-core/dist/dynamic/components/HelperText';
@@ -134,22 +134,18 @@ const AttributionInformation: React.FC<Props> = ({
   };
 
   return (
-    <FormFieldGroupExpandable
-      toggleAriaLabel="Details"
-      header={
-        <FormFieldGroupHeader
-          titleText={{
-            text: (
-              <p>
-                Attribution Information <span style={{ color: 'red' }}>*</span>
-              </p>
-            ),
-            id: 'attribution-info-id'
-          }}
-          titleDescription="Provide attribution information."
-        />
-      }
-    >
+    <div>
+      <FormFieldGroupHeader
+        titleText={{
+          text: (
+            <p>
+              Attribution Information <span style={{ color: 'red' }}>*</span>
+            </p>
+          ),
+          id: 'attribution-info-id'
+        }}
+        titleDescription="Provide attribution information."
+      />
       <FormGroup isRequired key={'attribution-info-details-work_link'} label="Work link or URL">
         <TextInput
           isRequired
@@ -264,7 +260,7 @@ const AttributionInformation: React.FC<Props> = ({
           </FormHelperText>
         )}
       </FormGroup>
-    </FormFieldGroupExpandable>
+    </div>
   );
 };
 

diff --git a/src/components/Contribute/Knowledge/DocumentInformation/DocumentInformation.tsx b/src/components/Contribute/Knowledge/DocumentInformation/DocumentInformation.tsx
@@ -1,5 +1,5 @@
 import React, { useEffect, useState } from 'react';
-import { FormFieldGroupExpandable, FormFieldGroupHeader, FormGroup, FormHelperText } from '@patternfly/react-core/dist/dynamic/components/Form';
+import { FormFieldGroupHeader, FormGroup, FormHelperText } from '@patternfly/react-core/dist/dynamic/components/Form';
 import { Button } from '@patternfly/react-core/dist/dynamic/components/Button';
 import { TextInput } from '@patternfly/react-core/dist/dynamic/components/TextInput';
 import { UploadFile } from './../UploadFile';
@@ -208,22 +208,18 @@ const DocumentInformation: React.FC<Props> = ({
   };
 
   return (
-    <FormFieldGroupExpandable
-      toggleAriaLabel="Details"
-      header={
-        <FormFieldGroupHeader
-          titleText={{
-            text: (
-              <p>
-                Document Information <span style={{ color: 'red' }}>*</span>
-              </p>
-            ),
-            id: 'doc-info-id'
-          }}
-          titleDescription="Add the relevant document's information"
-        />
-      }
-    >
+    <div>
+      <FormFieldGroupHeader
+        titleText={{
+          text: (
+            <p>
+              Document Information <span style={{ color: 'red' }}>*</span>
+            </p>
+          ),
+          id: 'doc-info-id'
+        }}
+        titleDescription="Add the relevant document's information"
+      />
       <FormGroup>
         <div style={{ display: 'flex', gap: '10px' }}>
           <Button
@@ -365,7 +361,7 @@ const DocumentInformation: React.FC<Props> = ({
           {failureAlertMessage}
         </Alert>
       )}
-    </FormFieldGroupExpandable>
+    </div>
   );
 };
 

diff --git a/src/components/Contribute/Knowledge/FilePathInformation/FilePathInformation.tsx b/src/components/Contribute/Knowledge/FilePathInformation/FilePathInformation.tsx
@@ -1,5 +1,5 @@
 import React from 'react';
-import { FormFieldGroupExpandable, FormFieldGroupHeader, FormGroup } from '@patternfly/react-core/dist/dynamic/components/Form';
+import { FormFieldGroupHeader, FormGroup } from '@patternfly/react-core/dist/dynamic/components/Form';
 import PathService from '@/components/PathService/PathService';
 
 interface Props {
@@ -10,27 +10,22 @@ interface Props {
 
 const FilePathInformation: React.FC<Props> = ({ reset, path, setFilePath }) => {
   return (
-    <FormFieldGroupExpandable
-      isExpanded
-      toggleAriaLabel="Details"
-      header={
-        <FormFieldGroupHeader
-          titleText={{
-            text: (
-              <p>
-                Taxonomy Directory Path <span style={{ color: 'red' }}>*</span>
-              </p>
-            ),
-            id: 'file-path-info-id'
-          }}
-          titleDescription="Specify the file path for the QnA and Attribution files. Once path is selected, please add your leaf directory name for your contribution."
-        />
-      }
-    >
+    <div>
+      <FormFieldGroupHeader
+        titleText={{
+          text: (
+            <p>
+              Taxonomy Directory Path <span style={{ color: 'red' }}>*</span>
+            </p>
+          ),
+          id: 'file-path-info-id'
+        }}
+        titleDescription="Specify the file path for the QnA and Attribution files. Once path is selected, please add your leaf directory name for your contribution."
+      />
       <FormGroup isRequired key={'file-path-service-id'}>
         <PathService reset={reset} rootPath="knowledge" path={path} handlePathChange={setFilePath} />
       </FormGroup>
-    </FormFieldGroupExpandable>
+    </div>
   );
 };
 

diff --git a/src/components/Contribute/Knowledge/KnowledgeInformation/KnowledgeInformation.tsx b/src/components/Contribute/Knowledge/KnowledgeInformation/KnowledgeInformation.tsx
@@ -1,5 +1,5 @@
 import React, { useEffect } from 'react';
-import { FormFieldGroupExpandable, FormFieldGroupHeader, FormGroup } from '@patternfly/react-core/dist/dynamic/components/Form';
+import { FormGroup } from '@patternfly/react-core/dist/dynamic/components/Form';
 import { TextInput } from '@patternfly/react-core/dist/dynamic/components/TextInput';
 import { TextArea } from '@patternfly/react-core/dist/dynamic/components/TextArea';
 import { HelperText } from '@patternfly/react-core/dist/dynamic/components/HelperText';
@@ -89,23 +89,11 @@ const KnowledgeInformation: React.FC<Props> = ({
   };
 
   return (
-    <FormFieldGroupExpandable
-      isExpanded
-      toggleAriaLabel="Details"
-      header={
-        <FormFieldGroupHeader
-          titleText={{
-            text: (
-              <p>
-                Knowledge Information <span style={{ color: 'red' }}>*</span>
-              </p>
-            ),
-            id: 'knowledge-info-id'
-          }}
-          titleDescription="Provide brief information about the knowledge."
-        />
-      }
-    >
+    <>
+      <h2>
+        Knowledge Information <span style={{ color: 'red' }}>*</span>
+      </h2>
+      <p>Provide brief information about the knowledge.</p>
       <FormGroup key={'knowledge-info-details-submission_summary'} label="Submission summary">
         <TextInput
           isRequired
@@ -166,7 +154,7 @@ const KnowledgeInformation: React.FC<Props> = ({
           </HelperText>
         )}
       </FormGroup>
-    </FormFieldGroupExpandable>
+    </>
   );
 };
 

diff --git a/...onents/Contribute/Knowledge/KnowledgeQuestionAnswerPairs/KnowledgeQuestionAnswerPairs.tsx b/...onents/Contribute/Knowledge/KnowledgeQuestionAnswerPairs/KnowledgeQuestionAnswerPairs.tsx
@@ -1,5 +1,5 @@
 import React from 'react';
-import { FormFieldGroupExpandable, FormFieldGroupHeader, FormGroup, FormHelperText } from '@patternfly/react-core/dist/dynamic/components/Form';
+import { FormFieldGroupHeader, FormGroup, FormHelperText } from '@patternfly/react-core/dist/dynamic/components/Form';
 import { TextArea } from '@patternfly/react-core/dist/dynamic/components/TextArea';
 import { ExclamationCircleIcon } from '@patternfly/react-icons/dist/dynamic/icons/';
 import { QuestionAndAnswerPair, SeedExample } from '..';
@@ -46,30 +46,24 @@ const KnowledgeQuestionAnswerPairs: React.FC<Props> = ({
         <FormHelperText key={seedExampleIndex * 10 + 2}>
           <HelperText>
             <HelperTextItem icon={<ExclamationCircleIcon />} variant={seedExample.isContextValid}>
-              {seedExample.validationError ? seedExample.validationError : 'Required field. It must be non empty and less than 500 words.'}
+              {seedExample.validationError || 'Required field. It must be non-empty and less than 500 words.'}
             </HelperTextItem>
           </HelperText>
         </FormHelperText>
       )}
 
       {seedExample.questionAndAnswers.map((questionAndAnswerPair: QuestionAndAnswerPair, questionAnswerIndex) => (
-        <FormFieldGroupExpandable
-          isExpanded
-          toggleAriaLabel="ContextDetails"
-          key={seedExampleIndex * 100 + questionAnswerIndex * 10 + 0}
-          header={
-            <FormFieldGroupHeader
-              titleText={{
-                text: (
-                  <p>
-                    Q&A Pair {questionAnswerIndex + 1} {questionAndAnswerPair.immutable && <span style={{ color: 'red' }}>*</span>}
-                  </p>
-                ),
-                id: 'nested-field-group1-titleText-id'
-              }}
-            />
-          }
-        >
+        <div key={seedExampleIndex * 100 + questionAnswerIndex * 10 + 0}>
+          <FormFieldGroupHeader
+            titleText={{
+              text: (
+                <p>
+                  Q&A Pair {questionAnswerIndex + 1} {questionAndAnswerPair.immutable && <span style={{ color: 'red' }}>*</span>}
+                </p>
+              ),
+              id: 'nested-field-group1-titleText-id'
+            }}
+          />
           <React.Fragment key={questionAnswerIndex}>
             <TextArea
               key={seedExampleIndex * 100 + questionAnswerIndex * 10 + 1}
@@ -116,7 +110,7 @@ const KnowledgeQuestionAnswerPairs: React.FC<Props> = ({
               </FormHelperText>
             )}
           </React.Fragment>
-        </FormFieldGroupExpandable>
+        </div>
       ))}
     </FormGroup>
   );