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

[doc] Full GUI userguide rewrite #3080

Merged
merged 1 commit into from
Jan 18, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
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
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ For more information how to use CodeChecker see our [user guide](usage.md).

## Web based report management
* [Webserver User Guide](web/user_guide.md)
* [WEB GUI User Guide](/web/server/www/userguide/userguide.md)
* [WEB GUI User Guide](/web/server/vue-cli/src/assets/userguide/userguide.md)
* [Command line and WEB UI Feature overview](feature_comparison.md)
* Security configuration
* [Configuring Authentication](web/authentication.md)
Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
967 changes: 642 additions & 325 deletions web/server/vue-cli/src/assets/userguide/userguide.md

Large diffs are not rendered by default.

61 changes: 25 additions & 36 deletions web/server/vue-cli/src/views/NewFeatures.vue
Original file line number Diff line number Diff line change
Expand Up @@ -917,7 +917,7 @@
</v-col>
<v-col>
<img
src="@/assets/userguide/images/bug_path_length_filter.png"
src="@/assets/userguide/images/new_features/6.10.0/bug_path_length_filter.png"
alt="Bug path length filter"
width="100%"
>
Expand Down Expand Up @@ -952,7 +952,7 @@
</v-col>
<v-col>
<img
src="@/assets/userguide/images/macro_expansion.png"
src="@/assets/userguide/images/new_features/6.9.1/macro_expansion.png"
alt="Macro expansion"
width="100%"
>
Expand Down Expand Up @@ -1040,7 +1040,7 @@
</v-col>
<v-col>
<img
src="@/assets/userguide/images/report_hash_filter.png"
src="@/assets/userguide/images/new_features/6.8.0/report_hash_filter.png"
alt="Report hash filter"
width="100%"
>
Expand All @@ -1062,7 +1062,7 @@
</v-col>
<v-col>
<img
src="@/assets/userguide/images/checker_statistics.png"
src="@/assets/userguide/images/statistics/checker_statistics.png"
alt="Checker statistics"
width="100%"
>
Expand All @@ -1084,7 +1084,7 @@
</v-col>
<v-col>
<img
src="@/assets/userguide/images/remove_filtered_reports.png"
src="@/assets/userguide/images/reports/remove_filtered_reports.png"
alt="Remove filtered reports"
width="100%"
>
Expand All @@ -1108,7 +1108,7 @@
</v-col>
<v-col>
<img
src="@/assets/userguide/images/list_of_source_components.png"
src="@/assets/userguide/images/reports/list_of_source_components.png"
alt="Manage source components"
width="100%"
>
Expand All @@ -1130,7 +1130,7 @@
</v-col>
<v-col>
<img
src="@/assets/userguide/images/analysis_statistics.png"
src="@/assets/userguide/images/new_features/6.8.0/analysis_statistics.png"
alt="Analysis statistics"
width="100%"
>
Expand All @@ -1142,32 +1142,21 @@
<template v-slot:title>
Fine gain control of Clang warnings
</template>
<v-row>
<v-col cols="8">
<p>
Compiler warnings are diagnostic messages that report
constructions that are not inherently erroneous but that are
risky or suggest there may have been an error. You can
fine-tune which warnings to use in the analysis by setting
the enabled and disabled flags. These flags should start with
a capital <b>W</b> or <b>Wno-</b> prefix followed by the
warning name.
</p>
<b>Examples:</b>
<ul>
<li>
<code>CodeChecker analyze /path/to/build.log -o /path/to/output/dir --enable Wunused --disable Wno-unused-parameter</code>
</li>
</ul>
</v-col>
<v-col>
<img
src="@/assets/userguide/images/analysis_statistics.png"
alt="Analysis statistics"
width="100%"
>
</v-col>
</v-row>
<p>
Compiler warnings are diagnostic messages that report
constructions that are not inherently erroneous but that are
risky or suggest there may have been an error. You can
fine-tune which warnings to use in the analysis by setting
the enabled and disabled flags. These flags should start with
a capital <b>W</b> or <b>Wno-</b> prefix followed by the
warning name.
</p>
<b>Examples:</b>
<ul>
<li>
<code>CodeChecker analyze /path/to/build.log -o /path/to/output/dir --enable Wunused --disable Wno-unused-parameter</code>
</li>
</ul>
</new-feature-item>

<new-feature-item>
Expand Down Expand Up @@ -1242,7 +1231,7 @@
</v-col>
<v-col>
<img
src="@/assets/userguide/images/component_filter.png"
src="@/assets/userguide/images/new_features/6.7.0/component_filter.png"
alt="Component filter"
width="100%"
>
Expand All @@ -1263,7 +1252,7 @@
</v-col>
<v-col>
<img
src="@/assets/userguide/images/run_tag_diff.png"
src="@/assets/userguide/images/reports/compare_tags.png"
alt="Diff tagged versions of the same run"
width="100%"
>
Expand Down Expand Up @@ -1294,7 +1283,7 @@
</v-col>
<v-col>
<img
src="@/assets/userguide/images/plist_to_html_index.png"
src="@/assets/userguide/images/new_features/6.7.0/plist_to_html_index.png"
alt="Plist to html"
width="100%"
>
Expand Down