Skip to content

Commit e605f6e

Browse files
authored
Add feedback submission guide (#613)
1 parent 24b69da commit e605f6e

12 files changed

+150
-0
lines changed
Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
# Feedback/Feature Request Submission
2+
3+
The **AI Quick Actions (AQUA)** interface provides a simple way to offer feedback directly from the UI. If you’ve spotted a bug or want to suggest a feature, you can easily submit it through GitHub.
4+
5+
This guide shows you how to do that step-by-step, using the example:
6+
> **"AQUA UI doesn't show container version for model deployment"**
7+
8+
---
9+
10+
## Table of Contents
11+
12+
- [Where to Find the Feedback Link](#where-to-find-the-feedback-link)
13+
- [Filling Out the Feedback Form](#filling-out-the-feedback-form)
14+
- [1. Add a title](#1-add-a-title)
15+
- [2. Feedback Type](#2-feedback-type)
16+
- [3. Summary](#3-summary)
17+
- [4. Steps to Reproduce](#4-steps-to-reproduce)
18+
- [5. Expected Behavior](#5-expected-behavior)
19+
- [6. Actual Behavior](#6-actual-behavior)
20+
- [7. Version or AI Quick Actions](#7-version-or-ai-quick-actions)
21+
- [8. Suggestions or Additional Notes](#8-suggestions-or-additional-notes)
22+
- [Submitting the Feedback](#submitting-the-feedback)
23+
24+
## Where to Find the Feedback Link
25+
26+
At the bottom of the **AI quick actions** banner, you’ll see:
27+
28+
> **"Have ideas or feedback? Let us know!"**
29+
30+
Clicking this link opens a pre-filled GitHub issue template:
31+
[Submit AQUA Feedback](https://github.com/oracle-samples/oci-data-science-ai-samples/issues/new?template=feedback_aqua.yml)
32+
33+
AQUA UI with feedback link
34+
![Feedback_Link](web_assets/feedback-link-banner.png)
35+
36+
---
37+
38+
## Filling Out the Feedback Form
39+
40+
Clicking the link will open a GitHub issue template with several fields. Below is how to fill it using our example: **Container Version Visibility**
41+
42+
> **Tip:** You can attach screenshots, logs, or any other relevant files to most section of the form to make your feedback clearer and more actionable.
43+
---
44+
45+
### 1. Add a title
46+
47+
Select the type of issue you want to report. For this example, it will be a:
48+
49+
> **Container Version Visibility**
50+
51+
52+
_Feedback type dropdown_
53+
![Title](web_assets/feedback-title.png)
54+
55+
---
56+
57+
### 2. Feedback Type
58+
59+
Select the type of issue you want to report. For this example, it will be a:
60+
61+
> **Feature Request**
62+
63+
64+
_Feedback type dropdown_
65+
![Dropdown](web_assets/feedback-type-dropdown.png)
66+
67+
---
68+
69+
### 3. Summary
70+
71+
Use a concise title that clearly states the issue or feature request.
72+
73+
> `AQUA UI doesn't show container version for model deployment`
74+
75+
_Summary_
76+
![Summary](web_assets/feedback-summary.png)
77+
---
78+
79+
### 4. Steps to Reproduce
80+
Describe the exact steps you took that led you to notice the issue or missing feature. This helps others reproduce the scenario and understand where it occurs in the UI. For this example, it will be:
81+
```text
82+
1. Open AQUA UI
83+
2. Go to "Model Deployments"
84+
3. Select a deployed model
85+
4. Notice that the container version is not shown in the UI
86+
```
87+
88+
_Deployment details view with missing container version:_
89+
![MDMissingVersion](web_assets/feedback-md-missing-version.png)
90+
91+
_Steps to Reproduce_
92+
![StepsToReproduce](web_assets/feedback-steps-to-reproduce.png)
93+
94+
---
95+
96+
### 5. Expected Behavior
97+
This helps the team understand what the user expects to see.
98+
```text
99+
The model deployment page should show:
100+
Container Version: v1.8.5
101+
```
102+
_Expected Behavior_
103+
![ExpectedBehavior](web_assets/feedback-expected-behavior.png)
104+
105+
---
106+
107+
### 6. Actual Behavior
108+
Describe what you observed in the UI or behavior that was unexpected or incorrect. This helps the team understand the problem from the user's perspective.
109+
```text
110+
The container version field is not visible. Users cannot confirm which version of the container is deployed.
111+
```
112+
_Actual Behavior_
113+
![ActualBehavior](web_assets/feedback-actual-behavior.png)
114+
115+
---
116+
117+
### 7. Version or AI QUick Actions
118+
119+
Provide details about your environment.
120+
121+
```text
122+
AQUA Version: v1.0.7
123+
```
124+
_Version or AI QUick Actions_
125+
![Version](web_assets/feedback-version.png)
126+
---
127+
128+
### 8. Suggestions or Additional Notes
129+
This optional section lets you suggest improvements, explain why the feature is important, or attach helpful context like screenshots or logs.
130+
```text
131+
Add a new field labeled “Container Version” in the model deployment details card.
132+
This helps with debugging and auditability.
133+
```
134+
135+
_Suggestions or Additional Notes_
136+
![Suggestions](web_assets/feedback-additional-info.png)
137+
138+
---
139+
140+
## Submitting the Feedback
141+
142+
After filling out all fields:
143+
144+
- Review your inputs for clarity
145+
- Click **Create** button
146+
147+
---
148+
149+
150+
22 KB
Loading
33.8 KB
Loading
22.4 KB
Loading
96.9 KB
Loading
117 KB
Loading
41.3 KB
Loading
16.4 KB
Loading
136 KB
Loading
31.3 KB
Loading

0 commit comments

Comments
 (0)