Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DEVPROD-5307: Documentation for Parsley Sectioning #8346

Merged
merged 5 commits into from
Oct 7, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions docs/UI/Parsley-Sectioning.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Parsley Sectioning

## Overview
Parsley sectioning is toggleable from the "Log Viewing" tab of the "Parsley Settings" menu and is available to task logs only. Toggling the feature will render your task log into expandable sections split up by function and command.
SupaJoon marked this conversation as resolved.
Show resolved Hide resolved

## Feature details
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit. Would just recommend double checking if you want these headers in title case or in sentence case since it's slightly inconsistent (e.g. Section status vs Jump to Failing Line)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good one. I'll stick to sentence case.


### Feature components
At the top of the log viewer, two buttons are available to "Open all sections" and "Close all sections". Clicking these buttons will expand and collapse every function and command section in the log file.

![Toggle All Sections](../images/toggle_all_sections.png)

There are also toggles available on function rows, "Open Subsections" and "Close Subsections", to expand and collapse all commands that belong to the function.
SupaJoon marked this conversation as resolved.
Show resolved Hide resolved

![Toggle Subsections](../images/toggle_subsections.png)

Clicking on the caret will also open and close a single command or function section.

![Toggle Single Section](../images/section_toggle.png)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you can omit this image (since it looks kinda odd just having the image of the caret) and just say

Suggested change
Clicking on the caret will also open and close a single command or function section.
![Toggle Single Section](../images/section_toggle.png)
The caret on the left-hand side can also be used to open or close a single command or function section.

which the reader can infer from the picture directly above


### Section status
A function containing a failing command is marked with a failing status icon whereas as passing function is marked with a passing icon.

![Passing Function](../images/passing_function.png)

![Failing Function](../images/failing_function.png)

### Jump to Failing Line
Jump to Failing Line is a separate feature that works synergistically with Sectioning. When enabled with Sectioning, Parsley will open the failing command section and scroll to the failing line during initial load.

### Searching
Sections that contain a search result will open. Iterating over search results will open the section if it's closed.
SupaJoon marked this conversation as resolved.
Show resolved Hide resolved

### Filtering
Sections will temporarily go away when filters are applied and come back when filters are removed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(or something along these lines)

Suggested change
Sections will temporarily go away when filters are applied and come back when filters are removed.
Sectioning cannot be used in conjunction with filters. Sections will not render when filters are applied, but will reappear when all filters are removed.


### Shareline
When a link with a share line is opened, Parsley will open the section that contains the share line and scroll to the line. The failing line section will still open but Parsley will scroll to the share line instead.
Comment on lines +35 to +36
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Shareline
When a link with a share line is opened, Parsley will open the section that contains the share line and scroll to the line. The failing line section will still open but Parsley will scroll to the share line instead.
### Share Line
Share line takes precedence over failing line. When a link with a share line is opened, Parsley will open the section that contains the share line and scroll to the line. The failing line section will still be open and accessible via the bookmarks bar.

Binary file added docs/images/failing_function.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/passing_function.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/section_toggle.png
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(can delete this file I think)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/toggle_all_sections.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/toggle_subsections.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading