Skip to content

Commit 3d184c9

Browse files
authored
DOCSP-44968-submit-feedback (#7)
* DOCSP-44968-submit-feedback * * * prereq * * * metadata tags * * * wording
1 parent 97f38ec commit 3d184c9

File tree

3 files changed

+123
-2
lines changed

3 files changed

+123
-2
lines changed

snooty.toml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@ intersphinx = [ "https://www.mongodb.com/docs/manual/objects.inv",
55
"https://www.mongodb.com/docs/atlas/objects.inv"
66
]
77

8-
toc_landing_pages = ["/connect"]
8+
toc_landing_pages = [
9+
"/connect",
10+
"/submit-feedback"
11+
]
912

1013
[constants]
1114
intellij-full = "MongoDB for IntelliJ Plugin"

source/logs.txt

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
.. _intellij-logs:
2+
3+
======================
4+
Retrieve IntelliJ Logs
5+
======================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
This page describes how to retrieve log files from IntelliJ IDEA.
16+
17+
About This Task
18+
---------------
19+
20+
Log files help the MongoDB development team diagnose bugs in the
21+
{+intellij-short+}. When you retrieve log files, IntelliJ generates a zip with
22+
the following contents:
23+
24+
- General information about the IDE installation such as version, host OS, host
25+
CPU, available memory, other plugins that might affect current functionality.
26+
- Thread dumps of the current state of IntelliJ.
27+
- Internal state of the UI.
28+
- OpenTelemetry metrics from IntelliJ.
29+
- Logs of all the plugins, including the {+intellij-full+}.
30+
31+
Steps
32+
-----
33+
34+
.. procedure::
35+
:style: normal
36+
37+
.. step:: In the IntelliJ top menu bar, click Help.
38+
39+
.. step:: In the Help menu, click Collect Logs and Diagnostic Data.
40+
41+
A pop-up warning appears, mentioning that the collected information might
42+
contain sensitive data.
43+
44+
.. step:: Click Show in Finder.
45+
46+
Learn More
47+
----------
48+
49+
- :ref:`intellij-submit-feedback`

source/submit-feedback.txt

Lines changed: 70 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,79 @@ Submit Feedback
66

77
.. default-domain:: mongodb
88

9+
.. facet::
10+
:name: genre
11+
:values: tutorial
12+
13+
.. meta::
14+
:description: Submit feedback on the MongoDB for IntelliJ Plugin JIRA project.
15+
916
.. contents:: On this page
1017
:local:
1118
:backlinks: none
1219
:depth: 1
1320
:class: singlecol
1421

15-
Content on this page will be addressed in DOCSP-44968.
22+
To report a bugs, request a feature, or submit general feedback, follow the
23+
procedures on this page to open a ticket in the
24+
`MongoDB for IntelliJ Plugin JIRA project <https://jira.mongodb.org/projects/INTELLIJ/issues/>`__.
25+
26+
Before You Begin
27+
----------------
28+
29+
To submit feedback and vote on issues, you must be logged in to a JIRA account.
30+
31+
Steps
32+
-----
33+
34+
.. procedure::
35+
:style: normal
36+
37+
.. step:: Open the ticket creation dialog.
38+
39+
To open a new ticket, click :guilabel:`Create` in the JIRA top navigation
40+
bar.
41+
42+
.. step:: Specify the issue type.
43+
44+
Open the :guilabel:`Issue Type` drop-down menu and select the appropriate
45+
issue type:
46+
47+
- If you encounter a bug, select :guilabel:`Bug`.
48+
49+
- If you have a new feature request, select :guilabel:`New Feature`.
50+
51+
.. step:: Provide a summary.
52+
53+
In the :guilabel:`Summary` field, provide a brief summary of the bug or
54+
feature request.
55+
56+
.. step:: Provide a description.
57+
58+
In the :guilabel:`Description` field, you can provide more detailed
59+
information, including the exact steps needed to reproduce the issue.
60+
61+
.. step:: Set the label field.
62+
63+
In the :guilabel:`Labels` field, include the ``internal-preview`` label.
64+
65+
.. step:: (*Optional*) Add logs in the Attachment field.
66+
67+
Logs can help navigate edge cases and diagnose issues in the
68+
{+intellij-short+}. For more information, see :ref:`intellij-logs`.
69+
70+
.. step:: Submit the ticket.
71+
72+
Click :guilabel:`Create` to submit the ticket.
73+
74+
Vote on Submitted Tickets
75+
-------------------------
76+
77+
Under the :guilabel:`People` section on the right side of the JIRA ticket, you
78+
can vote for tickets. Issues with more votes are more likely to be prioritized
79+
by the MongoDB development team.
80+
81+
.. toctree::
82+
:titlesonly:
83+
84+
Logs </logs>

0 commit comments

Comments
 (0)