Restructure and update documentation #1029
Merged
Conversation
This file contains hidden or 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
The commit includes the following changes: * Fresh Async Profiler logo. Font used is Tienne which is a google font free for commercial use. The logo image is the demo flamegraph image. * Create new chapters for FAQs and Troubleshooting.
apangin
reviewed
Oct 17, 2024
krk
reviewed
Oct 17, 2024
krk
reviewed
Oct 17, 2024
The commit include the following changes: * Create a new chapter explaining flame graph interpretations. * Create a chapter out of getting started section and add some more information. * Create a chapter out of profiling section.
krk
reviewed
Oct 23, 2024
The commit includes the following changes: * Create a new chapter for Profiling in container. * Create a new chapter for alternative ways to use async-profiler. * Link alternate ways to use async-profiler to getting started doc.
apangin
reviewed
Oct 24, 2024
The commit includes the following changes: * A new chapter detailing profiler options for asprof and launch as agent in tabular format. * Cosmetic refactors in other chapters.
roy-soumadipta
force-pushed
the
restructure_readme
branch
from
4fecd6e to
cfc2767
Compare
Signed-off-by: Soumadipta Roy <133005763+roy-soumadipta@users.noreply.github.com>
roy-soumadipta
force-pushed
the
restructure_readme
branch
from
c5abf08 to
2a10b21
Compare
apangin
reviewed
Nov 1, 2024
apangin
reviewed
Nov 5, 2024
The commit includes the following changes: * Address comments on flame graph interpretation chapter. * Move restrictions to troubleshooting section.
apangin
reviewed
Nov 11, 2024
apangin
changed the title
apangin
reviewed
Nov 14, 2024
apangin
reviewed
Nov 18, 2024
apangin
reviewed
Nov 18, 2024
apangin
reviewed
Nov 18, 2024
Signed-off-by: Andrei Pangin <1749416+apangin@users.noreply.github.com>
apangin
pushed a commit
that referenced
this pull request
Dec 3, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The commit includes the following changes:
Related issues
N/A
Motivation and context
Restructure Readme file for better readability and more information.
How has this been tested?
Logo has been tested with branch https://github.com/roy-soumadipta/async-profiler/blob/readme_restructure/README.md
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.