Merge pull request #1235 from andrewnicols/directoryRestructure

andrewnicols · web-flow · commit 9fd1421b8b58 · 2025-01-22T06:19:02.000Z
Project information for directory restructure
diff --git a/config/navbar.js b/config/navbar.js
@@ -56,6 +56,13 @@ const navbar = {
             label: 'Processes',
             docsPluginId: 'general',
         },
+        {
+            type: 'docSidebar',
+            position: 'left',
+            sidebarId: 'projects',
+            label: 'Projects',
+            docsPluginId: 'general',
+        },
         {
             type: 'docSidebar',
             position: 'left',
diff --git a/data/projects.json b/data/projects.json
@@ -1,6 +1,27 @@
 {
     "$schema": "../static/schema/projects.json",
     "projects": {
+        "directoryrestructure/index": {
+            "title": "Directory Restructure",
+            "status": "In Progress",
+            "owners": [
+                {
+                    "name": "Andrew Lyons",
+                    "githubUsername": "andrewnicols"
+                }
+            ],
+            "discussionLinks": [],
+            "issueLinks": [
+                {
+                    "link": "https://tracker.moodle.org/browse/MDL-83424",
+                    "title": "MDL-83424"
+                },
+                {
+                    "link": "https://tracker.moodle.org/browse/IDEA-75",
+                    "title": "Roadmap Proposal"
+                }
+            ]
+        },
         "docs/migration": {
             "title": "Dev Docs Migration",
             "status": "In Progress",
diff --git a/general/projects/directoryrestructure/index.md b/general/projects/directoryrestructure/index.md
diff --git a/project-words.txt b/project-words.txt
@@ -39,7 +39,9 @@ Josep
 JMeter
 JWKS
 Kanban
+Laravel
 MAINNODE
+MDK
 MDL
 MDLQA
 MDLSITE
@@ -49,6 +51,7 @@ Moodleisms
 Moodlelib
 Moodlenet
 Moodlers
+Moosh
 Multilang
 MyISAM
 MySQLi
@@ -73,6 +76,7 @@ SIGINT
 SIGTERM
 Soulier
 Stene
+Symfony
 TCPDF
 TODO
 ToBic
diff --git a/src/components/Project/index.ts b/src/components/Project/index.ts
@@ -23,12 +23,14 @@ export declare interface Link {
     link: string,
 }
 
+declare interface IssueLinks extends Array<Link> {}
+
 export declare interface ProjectSummaryData {
     projectName: string,
     title: string,
     owners: Array<PersonProps>,
     status: string,
-    issueLinks?: Array<Link>,
+    issueLinks?: IssueLinks,
     discussionLinks?: Array<Link>,
 }
 
diff --git a/src/components/ProjectSummary/index.tsx b/src/components/ProjectSummary/index.tsx
@@ -48,6 +48,38 @@ export default function ProjectSummary(props: ProjectSummaryProps): ReactNode {
         );
     }
 
+    function getIssueLinks({ issueLinks }: ProjectSummaryData): ReactNode {
+        if (issueLinks.length === 1) {
+            return (
+                <>
+                    {issueLinks.map(({ link, title }) => (
+                        <div key={title}>
+                            <Link
+                                to={link}
+                            >
+                                {title}
+                            </Link>
+                        </div>
+                    ))}
+                </>
+            );
+        }
+
+        return (
+            <ul>
+                {issueLinks.map(({ link, title }) => (
+                    <li key={title}>
+                        <Link
+                            to={link}
+                        >
+                            {title}
+                        </Link>
+                    </li>
+                ))}
+            </ul>
+        );
+    }
+
     function GetProjectSummary(projectData: ProjectSummaryData): ReactNode {
         return (
             <div className={styles.projectsummary}>
@@ -82,17 +114,7 @@ export default function ProjectSummary(props: ProjectSummaryProps): ReactNode {
                             && (
                                 <tr>
                                     <th>Issues</th>
-                                    <td>
-                                        {projectData.issueLinks.map(({ link, title }) => (
-                                            <div key={title}>
-                                                <Link
-                                                    to={link}
-                                                >
-                                                    {title}
-                                                </Link>
-                                            </div>
-                                        ))}
-                                    </td>
+                                    <td>{getIssueLinks(projectData)}</td>
                                 </tr>
                             )}
                     </tbody>
diff --git a/src/components/ProjectSummary/styles.module.css b/src/components/ProjectSummary/styles.module.css
@@ -1,6 +1,5 @@
 .projectsummary {
   float: right;
   clear: both;
-  font-family: monospace;
   padding-left: 1rem;
 }

Original file line number	Diff line number	Diff line change
`@@ -23,12 +23,14 @@ export declare interface Link {`
`23`	`23`	`link: string,`
`24`	`24`	`}`
`25`	`25`
	`26`	`+declare interface IssueLinks extends Array<Link> {}`
	`27`	`+`
`26`	`28`	`export declare interface ProjectSummaryData {`
`27`	`29`	`projectName: string,`
`28`	`30`	`title: string,`
`29`	`31`	`owners: Array<PersonProps>,`
`30`	`32`	`status: string,`
`31`		`- issueLinks?: Array<Link>,`
	`33`	`+ issueLinks?: IssueLinks,`
`32`	`34`	`discussionLinks?: Array<Link>,`
`33`	`35`	`}`
`34`	`36`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,5 @@`
`1`	`1`	`.projectsummary {`
`2`	`2`	`float: right;`
`3`	`3`	`clear: both;`
`4`		`- font-family: monospace;`
`5`	`4`	`padding-left: 1rem;`
`6`	`5`	`}`