EPMRPP-107599 + EPMRPP-108583 || Updates for FAQ section, Import page, Tutorial

[pressayuliya]

Summary by CodeRabbit

• Documentation
  • Added two FAQ entries: how to check API health (with illustration) and a comprehensive list of application limits with examples (with illustration).
  • Updated FAQ index to include the new entries following item 16.
  • Expanded Import plugin docs with explicit support for JUnit XML and Robot Framework, clarified behavior and outputs, and added step-by-step usage guidance.
  • Clarified tutorial wording to reference default ReportPortal Demo credentials.

[coderabbitai]

Walkthrough

Adds two documentation updates and one wording tweak: new FAQ entries about API health check and application limits in docs/FAQ/index.md, expanded guidance and specifics for the Import plugin in docs/plugins/import/index.md, and clarified demo credentials wording in docs/tutorial/index.mdx.

Changes

Cohort / File(s)	Summary of Changes
Docs: FAQ additions docs/FAQ/index.md	Added FAQ items 17 (API check via /composite/info with image) and 18 (application limits list with examples and image); inserted after existing item 16.
Docs: Import plugin specifics docs/plugins/import/index.md	Rewrote content to specify supported formats (JUnit XML, Robot Framework), added usage bullets, clarified behavior (saving JUnit as a launch), and noted manual/API import packaging.
Docs: Tutorial wording docs/tutorial/index.mdx	Clarified login example to “default ReportPortal Demo credentials.”

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

• AmsterGet
• maria-hambardzumian

Poem

Thump-thump goes my reviewer heart, so spry 🐇
New FAQs hop in, clear as the sky.
Imports line up, JUnit in tow,
Tutorials whisper where creds should go.
I twitch my ears, approve with glee—
Docs refreshed, as sweet as clover tea! 🌿

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title clearly summarizes the main changes by listing the updated documentation sections—FAQ, Import page, and Tutorial—which directly reflects the content added and revised in this documentation-only pull request.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch EPMRPP-107599

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

docs/plugins/import/index.md (1)

15-20: Tighten wording for clarity

Please switch to “either manually or via API calls,” fix the singular “saves it” to match the plural “files,” and keep “Robot Framework” spaced consistently. Something like:

-You can **import CI/CD results into ReportPortal** both manually or via API calls.
+You can **import CI/CD results into ReportPortal** either manually or via API calls.
 …
-The plugin reads the test report files and saves it as a launch in ReportPortal.
+The plugin reads the test report files and saves them as a launch in ReportPortal.
 …
-The **RobotFramework** import plugin works in a similar way.
+The **Robot Framework** import plugin works in a similar way.

docs/FAQ/index.md (2)

124-162: Use proper headings instead of bold labels

Markdownlint flags these bold lines (“1. Pagination & Collections”, etc.) as headings in disguise. Converting them to level-4 headings both resolves MD036 and keeps the section skimmable:

-**1. Pagination & Collections**
+#### 1. Pagination & Collections
…
-**2. Dashboards & Widgets**
+#### 2. Dashboards & Widgets
…
-**3. Attributes & Text Fields**
+#### 3. Attributes & Text Fields
…
-**4. Files, Uploads & Storage**
+#### 4. Files, Uploads & Storage
…
-**5. API Behavior & Miscellaneous**
+#### 5. API Behavior & Miscellaneous
…
-**6. Launch Merge**
+#### 6. Launch Merge

---

152-154: Fix nested list indentation

Markdownlint MD007 points out the extra leading space before the avatar sub-items. Shift them two spaces in so they render correctly:

-   - Accepted formats: **JPEG, PNG, GIF**
-   - Maximum size: **1 MB**
-   - Maximum dimensions: **300×500 px**
+  - Accepted formats: **JPEG, PNG, GIF**
+  - Maximum size: **1 MB**
+  - Maximum dimensions: **300×500 px**

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f51594d and 91fc406.

⛔ Files ignored due to path filters (1)

• docs/FAQ/img/ApiService.png is excluded by !**/*.png

📒 Files selected for processing (3)

• docs/FAQ/index.md (2 hunks)
• docs/plugins/import/index.md (1 hunks)
• docs/tutorial/index.mdx (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

docs/FAQ/index.md

124-124: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

134-134: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

141-141: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

147-147: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

152-152: Unordered list indentation
Expected: 2; Actual: 3

(MD007, ul-indent)

---

153-153: Unordered list indentation
Expected: 2; Actual: 3

(MD007, ul-indent)

---

154-154: Unordered list indentation
Expected: 2; Actual: 3

(MD007, ul-indent)

---

157-157: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

162-162: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)