-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9fec3cd
commit 0c3d750
Showing
11 changed files
with
28 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 changes: 5 additions & 5 deletions
10
application/client/src/assets/documentation/charts/create.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,13 @@ | ||
# Creating of filters | ||
|
||
To create chart: | ||
To create a chart: | ||
|
||
- focus in search input | ||
- enter search condition as regex and group with digits value, for example `cpu=(\d{1,})` | ||
- press "Enter" to activate condition | ||
- click on chart icon | ||
- switch to tab "Charts" | ||
- press "Enter" to activate the condition | ||
- click on the chart icon | ||
- switch to the tab "Charts" | ||
|
||
![Creating of charts](assets/documentation/charts/charts_filters.gif) | ||
|
||
In tab "Charts" also is rendering a frequency of matches for filters | ||
In tab "Charts" also renders a frequency of matches for filters |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
# Charts in streams | ||
|
||
As soon as chart has been created, chipmunk updates values and rebuild chart withing new values. | ||
As soon as the chart has been created, Chipmunk updates values and rebuilds the chart withing new values. | ||
|
||
![Charts in stream](assets/documentation/charts/charts_dynamic.gif) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
application/client/src/assets/documentation/navigation/favorites.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
# Favorites | ||
|
||
To have quick access to places, where logs files are stored, folder(s) can be added into favorites. On chipmunk's home screen all files from favorites folder(s) will be listed with possibility to filter it by name. | ||
To have quick access to places, where log files are stored, folder(s) can be added into favorites. On Chipmunk's home screen, all files from the favorites folder(s) will be listed with the possibility to filter them by name. | ||
|
||
![Favorites](assets/documentation/navigation/recent_actions_favorities.gif) | ||
|
||
In addition to home screen favorities also available with `Ctrl + P` (`Command + P`). In this case file(s) from favorities places are mixed with recent actions. | ||
In addition to home screen favorites are also available with `Ctrl + P` (`Command + P`). In this case file(s) from favorite places are mixed with recent actions. |
4 changes: 2 additions & 2 deletions
4
application/client/src/assets/documentation/navigation/recents.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
# Recent actions | ||
|
||
Chipmunk track not only recently opened files, but also recently created streams. | ||
Chipmunk tracks not only recently opened files but also recently created streams. | ||
|
||
Main list of recent actions is present on Chipmunk's home screen. But it also available with `Ctrl + P` (`Command + P`). In this case a recent actions list are mixed with file(s) from favorities places. | ||
The main list of recent actions is present on Chipmunk's home screen. But it is also available with `Ctrl + P` (`Command + P`). In this case, a recent actions list is mixed with file(s) from favorite places. | ||
|
||
![Favorites](assets/documentation/navigation/recent_actions_favorities.gif) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,9 @@ | ||
# Active search condition | ||
|
||
If some value is present in search input - it's an active search and search results are present *only* for this filter. | ||
If some value is present in the search input - it's an active search and search results are present *only* for this filter. | ||
|
||
Any saved filter can be quickly converted to active search via: | ||
- context menu "Show matches" | ||
- double click on filter in a list | ||
|
||
![Active filter](assets/documentation/search/filters_show_matches.gif) | ||
|
||
- double-click on the filter in a list | ||
|
||
![Active filter](assets/documentation/search/filters_show_matches.gif) |
2 changes: 1 addition & 1 deletion
2
application/client/src/assets/documentation/search/breadcrumbs.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
# Breadcrumbs Mode | ||
|
||
Breadcrumbs mode allows mix search result and other content. It's very useful in cases when it's important to undestand what was logged before/after target occasion. | ||
Breadcrumbs mode allows mixed search results and other content. It's very useful in cases when it's essential to understand what was logged before/after the target occasion. | ||
|
||
![Breadcrumbs mode](assets/documentation/search/breadcrumbs.gif) |
12 changes: 6 additions & 6 deletions
12
application/client/src/assets/documentation/search/create.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,13 @@ | ||
# Creating of filters | ||
|
||
To create filter: | ||
To create a filter: | ||
|
||
- focus in search input | ||
- enter search condition | ||
- press "Enter" to activate search | ||
- press "Enter" once again or click on filter icon | ||
- enter the search condition | ||
- press "Enter" to activate the search | ||
- press "Enter" once again or click on the filter icon | ||
|
||
As result filter will be saved in a list of filters. | ||
Chipmunk support any number of filters/charts, but a performance of a search depends on number of filters/charts. | ||
As a result, the filter will be saved in a list of filters. | ||
Chipmunk supports any number of filters/charts, but the performance of a search depends on the number of filters/charts. | ||
|
||
![Creating of filters](assets/documentation/search/filters_create.gif) |
6 changes: 3 additions & 3 deletions
6
application/client/src/assets/documentation/search/importing.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,10 @@ | ||
# Import/export filters | ||
|
||
Filters/charts will be associated with opened file (or stream). Next time same file (or stream) is opened, filters/charts will be restored. | ||
Filters/charts will be associated with an opened file (or stream). Next time the same file (or stream) is opened, filters/charts will be restored. | ||
|
||
In same time there are a couple of ways to export/import filters: | ||
At the same time, there are a couple of ways to export/import filters: | ||
|
||
- via context menu on list of filters/charts | ||
- via the context menu on the list of filters/charts | ||
- via tab "History/Profiles" to export/import different collections of filters/charts | ||
|
||
![Import/Export](assets/documentation/search/importing.gif) |
6 changes: 3 additions & 3 deletions
6
application/client/src/assets/documentation/search/manipulation.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
# Checked / uncheked / disabled filters | ||
# Checked/Unchecked/Disabled filters | ||
|
||
- *Cheked* filer will be used to make a search and matches will be shown in a search results view. | ||
- *Unchecked* filters will no be used to make a search, but colors still are applying and rows with matches will be highlighted in main view. | ||
- *Disabled* filter will not be considered in search and will not be highlighted. Disabling of filters are useful to turn off some filter complitely, but still have a way to quickly restore it | ||
- *Unchecked* filters will not be used to make a search, but colors still be applied and rows with matches will be highlighted in the main view. | ||
- *Disabled* filter will not be considered in the search and will not be highlighted. Disabling filters are useful to turn off some filter completely but still have a way to quickly restore it | ||
|
||
![Filters manipulation](assets/documentation/search/filters_enable_disable.gif) |