Main issue templates (#69)

thedannywahl · web-flow · commit 576a137ec696 · 2025-10-01T14:33:40.000-06:00
* remove extra params

* fix correct workspace type

* remove extra type declarations

* add issue template
diff --git a/.github/ISSUE_TEMPLATE/1-bug.yml b/.github/ISSUE_TEMPLATE/1-bug.yml
@@ -0,0 +1,27 @@
+name: Bug Report
+description: Report a bug in the project
+title: "[BUG]: "
+labels: Bug
+body:
+  - type: dropdown
+    id: package
+    attributes:
+      label: Affected Package
+      description: Select the affected package (will be reported as
+        @instructure.ai/[package])
+      options:
+        - shared-configs
+        - nutritionfacts
+        - roadmap
+        - site
+      default: 0
+      validations:
+        required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Provide a clear and concise description of the bug.
+      placeholder: Describe the bug here...
+      validations:
+        required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
+blank_issues_enabled: true
diff --git a/apps/nutritionfacts/src/assets/cache.csv b/apps/nutritionfacts/src/assets/cache.csv
@@ -6,4 +6,5 @@ canvasGradingAssistance,2025.09.10,Grading Assistance,"AI powered automatic grad
 discussionInsights,2025.09.12,Discussion Insights,"Discussion Insights uses AI to evaluate student discussion replies, highlight relevant contributions, and flag those that may need instructor review.",Haiku 3,Anthropic Claude models are provided via Amazon Bedrock Foundation Models (FMs).,No,Course,"Discussion topic, prompt, and student replies are used.",No user data is stored or reused by the model.,Logs data,Model evaluations and reply labels are logged for debugging and troubleshooting purposes.,Global,,Exposed,"Known PII is masked before being sent to the model, though any PII present in the discussion reply is not and may be shared with the model.",Yes,Yes,Instructors may review AI-generated evaluations or review posts directly.,"Model responses are logged for quality assurance, and responses with low confidence are flagged ""Needs Review"" to encourage human intervention.",The model may misclassify some nuanced replies.,"Instructors are able to quickly assess the quality of student replies, identify low-effor or off-topic contributions, and focus their attention to where it is needed most.",Canvas,2
 smartSearch,2025.09.12,Smart Search,Natural language search of course content for students and instructors.,Cohere Embed Multilingual,Cohere models are provided via Amazon Bedrock Foundation Models (FMs).,No,Course,Course content is indexed by the model and then stored in the Canvas database.,Data is not stored or reused by the model. Indexed course content is stored in the Canvas database.,Does not log data,,Global,,Not Exposed,"PII in course content may be indexed, but no PII is intentionally sent to the model.",Yes,Yes,Users are presented with a list of results related to their search query and can act or not act on them.,,Search results may be incorrectly sorted or may not be relevant to the search term.,"Student are able to quicly find answers to questions, and instructors are able to quickly navigate their courses.",Canvas,2
 askyourdata,2025.09.12,Ask Your Data,AI-powered query tool enables users to ask natural language questions and receive textual or visual responses with detailed explanations of the methodology.,Doowii (multiple),"Doowii is a third-party sub-processor for Intelligent Insights. Doowii's tools use OpenAI GPT-4o, GPT-3.5 Turbo, and Claude Sonnet 3.5",No,Other,"Doowii is trained on the Canvas LMS database schema, and receives no data from Canvas. The user's prompt and heuristics (such as summary statistics) are shared with the model to generate a response.",Data is retained through the life of your contract with Instructure.,Logs data,,Global,,Exposed,"Prompt, summary statistics.",Yes,Yes,Ask your data returns a methodology description along with a generated query. Users have the ability to edit the generated SQL directly.,"Questions are scoped to the domain only, highly ambiguous terms ask for clarification.",Incorrect interpretation of the question. Inaccurate SQL may be generated. Suggested questions or methodologies may not be relevant.,Provide accurate data retrieval and analysis through natural language prompting.,Intelligent Insights,2
-canvasDiscussionSummaries,2025.09.12,Discussion Summaries,"Discussion summaries of key points, questions, and insights.",Haiku 3,Anthropic Claude models are provided via Amazon Bedrock Foundation Models (FMs).,No,Course,Discussion prompt and replies.,Data is not stored or reused by the model.,Logs data,Summaries are logged in the Canvas database for review and reuse.,Global,,Not Exposed,"Pii in discussion replies may be sent to the model, but no PII is intentionally sent to the model.",Yes,Yes,Instructors may regenerate summaries or fine-tune them with additional instructions.,,Summaries may not capture all desired information.,Summaries allow discussion topics to be used in large-format courses and other environments where discussions were previously infeasible.,Canvas,2
+canvasDiscussionSummaries,2025.09.12,Discussion Summaries,"Discussion summaries of key points, questions, and insights.",Haiku 3,Anthropic Claude models are provided via Amazon Bedrock Foundation Models (FMs).,No,Course,Discussion prompt and replies.,Data is not stored or reused by the model.,Logs data,Summaries are logged in the Canvas database for review and reuse.,Global,,Not Exposed,"Pii in discussion replies may be sent to the model, but no PII is intentionally sent to the model.",Yes,Yes,Instructors may regenerate summaries or fine-tune them with additional instructions.,,Summaries may not capture all desired information.,Summaries allow discussion topics to be used in large-format courses and other environments where discussions were previously infeasible.,Canvas,2
+BCEAltText,2025.10.01,Block Content Editor Alt Text Generator,,Haiku 3,Anthropic Claude models are provided via Amazon Bedrock Foundation Models (FMs).,No,Course,Content Editor Images.,Model responses are stored for debugging purposes.,Logs data,"Request, response, and feedback data is logged to assist in troubleshooting.",Global,,Not Exposed,,No,Yes,"User initiated, User must confirm output.",,Alt text might not always be accurate. ,An accessible Alt Text description of the image is generated.,Canvas,2
diff --git a/apps/nutritionfacts/src/assets/cache.json b/apps/nutritionfacts/src/assets/cache.json
@@ -1,8 +1,8 @@
 {
   "cache": {
-    "sha256": "ab4dd4bef0792fd0e5d98e7985c93184423b3dd773e6cd305050dd7295ed3228",
-    "lastUpdated": "1758643492",
-    "count": 9
+    "sha256": "718e0ce0bbb49165aadeffc5cec3802b40414990ce756efa7e97a0a3b68f6fe2",
+    "lastUpdated": "1759349310",
+    "count": 10
   },
   "features": {
     "canvasinboxtranslation": {
@@ -1057,6 +1057,123 @@
         "permissions": 2,
         "revision": "2025.09.12"
       }
+    },
+    "bcealttext": {
+      "sha256": "357dbdae5027f884c3ba0be04b700880b3f302cbced8eff6120a672decfde34d",
+      "lastUpdated": "1759349310",
+      "id": "bcealttext",
+      "name": "Block Content Editor Alt Text Generator",
+      "nutritionFacts": {
+        "data": [
+          {
+            "blockTitle": "Model & Data",
+            "segmentData": [
+              {
+                "description": "The foundational AI on which further training and customizations are built.",
+                "descriptionHint": "Describe the base model",
+                "segmentTitle": "Base Model",
+                "value": "Haiku 3",
+                "valueDescription": "Anthropic Claude models are provided via Amazon Bedrock Foundation Models (FMs).",
+                "valueHint": "Input base model"
+              },
+              {
+                "description": "Indicates the AI model has been given customer data in order to improve its results.",
+                "segmentTitle": "Trained with User Data",
+                "value": "No",
+                "valueHint": "Yes / No"
+              },
+              {
+                "description": "Indicates which training or operational content was given to the model.",
+                "descriptionHint": "Describe the data shared",
+                "segmentTitle": "Data Shared with Model",
+                "value": "Course",
+                "valueDescription": "Content Editor Images.",
+                "valueHint": "Select shared data set"
+              }
+            ]
+          },
+          {
+            "blockTitle": "Privacy & Compliance",
+            "segmentData": [
+              {
+                "description": "How long the model stores customer data.",
+                "descriptionHint": "Describe the data retention period",
+                "segmentTitle": "Data Retention",
+                "valueDescription": "Model responses are stored for debugging purposes."
+              },
+              {
+                "description": "Recording the AI's performance for auditing, analysis, and improvement.",
+                "descriptionHint": "Describe the data logging practices",
+                "segmentTitle": "Data Logging",
+                "value": "Logs data",
+                "valueDescription": "Request, response, and feedback data is logged to assist in troubleshooting.",
+                "valueHint": "Logs data / Does not log data"
+              },
+              {
+                "description": "The locations where the AI model is officially available and supported.",
+                "descriptionHint": "Describe the supported regions",
+                "segmentTitle": "Regions Supported",
+                "value": "Global",
+                "valueDescription": "",
+                "valueHint": "Select region(s)"
+              },
+              {
+                "description": "Sensitive data that can be used to identify an individual.",
+                "descriptionHint": "Describe the handling of PII",
+                "segmentTitle": "PII",
+                "value": "Not Exposed",
+                "valueDescription": "",
+                "valueHint": "Exposed / Not Exposed"
+              }
+            ]
+          },
+          {
+            "blockTitle": "Outputs",
+            "segmentData": [
+              {
+                "description": "The ability to turn the AI on or off within the product.",
+                "segmentTitle": "AI Settings Control",
+                "value": "No",
+                "valueHint": "Yes / No"
+              },
+              {
+                "description": "Indicates if a human is involved in the AI's process or output.",
+                "descriptionHint": "Describe the human involvement",
+                "segmentTitle": "Human in the Loop",
+                "value": "Yes",
+                "valueDescription": "User initiated, User must confirm output.",
+                "valueHint": "Yes / No"
+              },
+              {
+                "description": "Preventative safety mechanisms or limitations built into the AI model.",
+                "descriptionHint": "Describe the guardrails",
+                "segmentTitle": "Guardrails",
+                "valueDescription": ""
+              },
+              {
+                "description": "Any risks the model may pose to the user.",
+                "descriptionHint": "Describe the expected risks",
+                "segmentTitle": "Expected Risks",
+                "valueDescription": "Alt text might not always be accurate. "
+              },
+              {
+                "description": "The specific results the AI model is meant to achieve.",
+                "descriptionHint": "Describe the intended outcomes",
+                "segmentTitle": "Intended Outcomes",
+                "valueDescription": "An accessible Alt Text description of the image is generated."
+              }
+            ]
+          }
+        ],
+        "description": "",
+        "descriptionHint": "Describe your feature",
+        "group": "Canvas",
+        "id": "BCEAltText",
+        "name": "Block Content Editor Alt Text Generator",
+        "nameHint": "Feature Name",
+        "permissions": 2,
+        "revision": "2025.10.01"
+      }
     }
   }
 }
diff --git a/package.json b/package.json
@@ -17,7 +17,8 @@
     "terser": "^5.44.0",
     "vite": "^7.1.7",
     "vite-node": "^3.2.4",
-    "vitest": "^3.2.4"
+    "vitest": "^3.2.4",
+    "yaml": "^2.8.1"
   },
   "version": "0.1.0",
   "name": "@instructure.ai/shared-configs",
@@ -33,6 +34,7 @@
     "test": "pnpm -r test",
     "typecheck": "pnpm -r typecheck",
     "preview": "vite-node ./scripts/preview.mts",
+    "update-issues": "vite-node ./scripts/issues.mts",
     "workspace": "vite-node ./scripts/info.mts"
   },
   "exports": {
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/scripts/build.mts b/scripts/build.mts
@@ -11,6 +11,7 @@ import {
 	unknownError,
 	Workspace,
 } from "@instructure.ai/shared-configs/workspace";
+import { updateIssues } from "./issues.mts";
 
 const main = async () => {
 	const { command, output, args } = Workspace();
@@ -127,6 +128,7 @@ const main = async () => {
 Valid commands are: ${buildCommands.join(", ")}`);
 				}
 		}
+		await updateIssues();
 	} catch (error) {
 		exitWithError("Build failed:", error);
 	}
diff --git a/scripts/info.mts b/scripts/info.mts
@@ -7,7 +7,7 @@ import {
 } from "@instructure.ai/shared-configs/workspace";
 
 const main = async () => {
-	const { output } = Workspace(["workspace"], "info");
+	const { output } = Workspace(["workspace"]);
 	exec(() => {
 		console.log(output);
 	});
diff --git a/scripts/issues.mts b/scripts/issues.mts
diff --git a/scripts/workspace.mts b/scripts/workspace.mts

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@ import {`
`11`	`11`	`unknownError,`
`12`	`12`	`Workspace,`
`13`	`13`	`} from "@instructure.ai/shared-configs/workspace";`
	`14`	`+import { updateIssues } from "./issues.mts";`
`14`	`15`
`15`	`16`	`const main = async () => {`
`16`	`17`	`const { command, output, args } = Workspace();`
`@@ -127,6 +128,7 @@ const main = async () => {`
`127`	`128`	Valid commands are: ${buildCommands.join(", ")}`);
`128`	`129`	`}`
`129`	`130`	`}`
	`131`	`+ await updateIssues();`
`130`	`132`	`} catch (error) {`
`131`	`133`	`exitWithError("Build failed:", error);`
`132`	`134`	`}`