Skip to content

Doc for greenlet profiler#250

Merged
wu-sheng merged 15 commits into
apache:masterfrom
jaychoww:doc_for_greenlet_profiler
Nov 17, 2022
Merged

Doc for greenlet profiler#250
wu-sheng merged 15 commits into
apache:masterfrom
jaychoww:doc_for_greenlet_profiler

Conversation

@jaychoww

@jaychoww jaychoww commented Nov 9, 2022

Copy link
Copy Markdown
Contributor

This is a simple document describes how the threading profiler and greenlet profiler work

@wu-sheng

wu-sheng commented Nov 9, 2022

Copy link
Copy Markdown
Member

All graphics should be submitted to https://github.com/apache/skywalking-website/tree/master/static/doc-graph + /python/1.0.0.
Then after the website is deployed, you could use the static links.
Ref to what we did in other repositories. apache/skywalking-banyandb#198 (comment)

@wu-sheng wu-sheng added the documentation Improvements or additions to documentation label Nov 9, 2022
@wu-sheng wu-sheng added this to the 1.0.0 milestone Nov 9, 2022
@wu-sheng

wu-sheng commented Nov 9, 2022

Copy link
Copy Markdown
Member

ignore lic checks for .drawio

These files matter. They can't be ignored.

@jaychoww

jaychoww commented Nov 9, 2022

Copy link
Copy Markdown
Contributor Author

All graphics should be submitted to https://github.com/apache/skywalking-website/tree/master/static/doc-graph + /python/1.0.0. Then after the website is deployed, you could use the static links. Ref to what we did in other repositories. apache/skywalking-banyandb#198 (comment)

All graphics should be submitted to https://github.com/apache/skywalking-website/tree/master/static/doc-graph + /python/1.0.0. Then after the website is deployed, you could use the static links. Ref to what we did in other repositories. apache/skywalking-banyandb#198 (comment)

Should I commit the .drawio files or only the PNG files into this repo?
And if we need the drawio files, what's the license format for the XML(drawio) file?

@wu-sheng

wu-sheng commented Nov 9, 2022

Copy link
Copy Markdown
Member

drawio files should be placed in the website, side by side with final png. @kezhenxu94 Is this good?

@kezhenxu94

Copy link
Copy Markdown
Member

Can you consider using mermaid syntax to draw? GitHub natively supports this framework and our website also support that so it works both in GitHub website and our website. Also it's simple markdown language.

@jaychoww jaychoww force-pushed the doc_for_greenlet_profiler branch from f1df1d3 to 3e573be Compare November 12, 2022 02:18
kezhenxu94
kezhenxu94 previously approved these changes Nov 12, 2022

@kezhenxu94 kezhenxu94 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for the works! @Superskyyy could you recheck the sequence diagram that it reflects the workflow?

Comment thread docs/en/profiling/profiling.md Outdated
Comment thread docs/en/profiling/profiling.md Outdated
Comment thread docs/en/profiling/profiling.md Outdated
Comment thread docs/en/profiling/profiling.md Outdated
Comment thread docs/en/profiling/profiling.md Outdated
Comment thread docs/en/profiling/profiling.md Outdated
Comment thread docs/en/profiling/profiling.md Outdated
jaychoww and others added 8 commits November 12, 2022 19:47
Co-authored-by: kezhenxu94 <kezhenxu94@apache.org>
Co-authored-by: kezhenxu94 <kezhenxu94@apache.org>
Co-authored-by: kezhenxu94 <kezhenxu94@apache.org>
Co-authored-by: kezhenxu94 <kezhenxu94@apache.org>
Co-authored-by: kezhenxu94 <kezhenxu94@apache.org>
Co-authored-by: kezhenxu94 <kezhenxu94@apache.org>
Co-authored-by: kezhenxu94 <kezhenxu94@apache.org>
@Superskyyy

Copy link
Copy Markdown
Member

Sorry for the delay I will take a look soon.

Comment thread docs/en/profiling/profiling.md Outdated
Co-authored-by: Superskyyy <Superskyyy@outlook.com>
@Superskyyy

Superskyyy commented Nov 17, 2022

Copy link
Copy Markdown
Member

Sequence diagram is clear enough and looking good to me, thank you for the important contribution!

@Superskyyy Superskyyy self-requested a review November 17, 2022 07:07
@wu-sheng wu-sheng merged commit 999f279 into apache:master Nov 17, 2022
@jaychoww jaychoww deleted the doc_for_greenlet_profiler branch October 24, 2023 03:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants