Skip to content

Commit 50f4c68

Browse files
(DOCSP-7619): Updating feature request method for new feedback engine (#199)
* (DOCSP-7619): Updating feature request method for new feedback engine * Updates per review
1 parent f9c4eba commit 50f4c68

File tree

4 files changed

+82
-33
lines changed

4 files changed

+82
-33
lines changed
Loading
94.5 KB
Loading
69.4 KB
Loading

source/submit-feedback.txt

Lines changed: 82 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -21,62 +21,111 @@ If you have an enterprise or professional MongoDB subscription,
2121
you can submit a ticket to the `Commercial Support JIRA
2222
<https://jira.mongodb.com>`_ for direct feedback and support.
2323

24-
Submit a Bug Ticket or Feature Request to JIRA
25-
----------------------------------------------
24+
Submit a Bug Report
25+
-------------------
2626

27-
To report a bug or feature request, submit a ticket to the
27+
To report a bug, submit a ticket to the
2828
`MongoDB Compass JIRA
2929
<https://jira.mongodb.org/projects/COMPASS/issues>`_.
3030

31-
Bug Ticket
32-
~~~~~~~~~~
31+
Procedure
32+
~~~~~~~~~
3333

34-
To submit a bug ticket:
34+
1. Click :guilabel:`Create` in the top navigation bar in JIRA to open
35+
the ticket creation dialog.
3536

36-
- Set the :guilabel:`Issue Type` to ``Bug``,
37+
#. Set the :guilabel:`Issue Type` to ``Bug``.
3738

38-
- Provide a :guilabel:`Summary`,
39+
#. Provide a :guilabel:`Summary` of the issue.
3940

40-
- Use the :guilabel:`Description` to list the exact steps needed to
41-
reproduce the issue,
41+
#. Set the :guilabel:`Component` to ``Compass``.
4242

43-
- Use the :guilabel:`Attachment` to upload screenshot(s) of the issue,
44-
and
43+
#. Use the :guilabel:`Affected Version/s` to list the version(s) of
44+
|compass-short| in which the issue occurs.
45+
46+
#. Use the :guilabel:`Environment` field to describe the operating
47+
system(s) in which the issue occurs.
4548

46-
- Specify the :guilabel:`Affected Version/s` and :guilabel:`Environment`
47-
for your new bug report.
49+
#. Use the :guilabel:`Description` to list the exact steps needed to
50+
reproduce the issue,
51+
52+
#. Use the :guilabel:`Attachment` to upload screenshot(s) of the issue.
4853

4954
.. figure:: /images/compass/sample-bug-ticket.png
5055
:alt: Sample bug ticket
5156
:figwidth: 600px
5257

53-
Feature Requests
54-
~~~~~~~~~~~~~~~~
58+
Vote on Bug Tickets
59+
~~~~~~~~~~~~~~~~~~~
5560

56-
To submit a feature request:
61+
After you login to JIRA, you can vote for a bug ticket in the
62+
:guilabel:`People` section on the right-hand side of the ticket. Issues
63+
with more votes are more likely to be prioritized by the Compass
64+
development team.
5765

58-
- Set the :guilabel:`Issue Type` to ``Story``,
66+
.. figure:: /images/compass/bug-votes.png
67+
:alt: Vote for bugs
68+
:figwidth: 450px
5969

60-
- Provide a :guilabel:`Summary`,
70+
Submit a Feature Request
71+
------------------------
6172

62-
- Use the :guilabel:`Description` to explain your goal(s), use case and
63-
reasoning for the new feature request.
73+
You can submit |compass-short| feature requests using the
74+
`MongoDB Feedback Engine <https://feedback.mongodb.com/forums/924283-compass>`__.
6475

65-
.. figure:: /images/compass/sample-feature-request.png
66-
:alt: Sample feature request
67-
:figwidth: 600px
76+
Procedure
77+
~~~~~~~~~
6878

69-
Vote on Issues
70-
~~~~~~~~~~~~~~
79+
1. Log in to the
80+
`Feedback Engine <https://feedback.mongodb.com/forums/924283-compass>`__
81+
using your MongoDB account.
7182

72-
After you login to JIRA, you can vote for any bug or feature request
73-
ticket in the :guilabel:`People` section on the right-hand side of the
74-
ticket. Issues with more votes are more likely to be prioritized by the
75-
Compass development team.
83+
#. Use the :guilabel:`Enter your idea` search bar to see if there are
84+
any matching or similar feature requests which have already been
85+
submitted. If those requests exist, you can
86+
:ref:`vote on those requests <feature-request-vote>`.
7687

77-
.. figure:: /images/compass/bug-votes.png
78-
:alt: Vote for bugs
79-
:figwidth: 450px
88+
.. figure:: /images/compass/feature-request-search.png
89+
:figwidth: 650px
90+
:alt: Search for existing features
91+
92+
#. If you cannot find a matching existing feature request, click
93+
:guilabel:`Post a New Idea`.
94+
95+
#. Fill in the requested information for your feature:
96+
97+
a. Enter a title for your idea.
98+
99+
#. (Optional) Select a category for your idea.
100+
101+
#. Describe your idea.
102+
103+
#. (Optional) Attach a screenshot or other document to help give
104+
context for your idea.
105+
106+
#. Click :guilabel:`Post Idea`.
107+
108+
The Feedback Engine directs you to a page with your feature request.
109+
You automatically vote on all features you submit.
110+
111+
.. _feature-request-vote:
112+
113+
Find and Vote on Existing Feature Requests
114+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
115+
116+
You can vote for features you would like to see added to |compass|.
117+
Feature requests with more votes are more likely to be prioritized by
118+
the Compass development team.
119+
120+
To search for features, use the :guilabel:`Enter your idea` search
121+
bar.
122+
123+
To vote for issues, click :guilabel:`Vote` for the issues you would
124+
like to see added.
125+
126+
.. figure:: /images/compass/feature-request-vote.png
127+
:figwidth: 650px
128+
:alt: Vote on existing features
80129

81130
Other Feedback
82131
--------------

0 commit comments

Comments
 (0)