Skip to content

Refactor current Python agent docs to serve on SkyWalking official website#162

Merged
kezhenxu94 merged 16 commits into
apache:masterfrom
Superskyyy:master
Sep 12, 2021
Merged

Refactor current Python agent docs to serve on SkyWalking official website#162
kezhenxu94 merged 16 commits into
apache:masterfrom
Superskyyy:master

Conversation

@Superskyyy

@Superskyyy Superskyyy commented Sep 12, 2021

Copy link
Copy Markdown
Member

Refactored and moved the existing docs into a more organized format suitable for SkyWalking Website to ingest and host.

Part of - apache/skywalking#7687

Visit my github.io deployment of the new docs -> https://superskyyy.github.io/docs/skywalking-python/latest/readme/

  • Refactor Python repo docs
  • Add new entry to website repo - TODO
  • Refactor Python repo main README - TODO

This PR deals with the first step ↑.

Once this one merges, I will PR to deploy the docs officially on the https://skywalking.apache.org/ website, finally update our main README to reflect the new documentation URL, and remove the lines belonging to the actual doc.

Signed-off-by: Superskyyy <Superskyyy@outlook.com>
Fix file extension
Signed-off-by: Superskyyy <Superskyyy@outlook.com>
Signed-off-by: Superskyyy <Superskyyy@outlook.com>
Signed-off-by: Superskyyy <Superskyyy@outlook.com>
Signed-off-by: Superskyyy <Superskyyy@outlook.com>
Signed-off-by: Superskyyy <Superskyyy@outlook.com>
Signed-off-by: Superskyyy <Superskyyy@outlook.com>
Signed-off-by: Superskyyy <Superskyyy@outlook.com>
Signed-off-by: Superskyyy <Superskyyy@outlook.com>
Signed-off-by: Superskyyy <Superskyyy@outlook.com>
Signed-off-by: Superskyyy <Superskyyy@outlook.com>
Signed-off-by: Superskyyy <Superskyyy@outlook.com>
Signed-off-by: Superskyyy <Superskyyy@outlook.com>

@wu-sheng wu-sheng 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.

Does the last todo mean, readme doc will be removed later, and link to website doc? If so, I am good.

@Superskyyy

Copy link
Copy Markdown
Member Author

Does the last todo mean, readme doc will be removed later, and link to website doc? If so, I am good.

Yes,exactly.

@wu-sheng wu-sheng 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.

Good to me. Wait for @kezhenxu94 to check doc details.

@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.

Thank you @Superskyyy very much

@Superskyyy

Copy link
Copy Markdown
Member Author

We might also need a doc for the profiling feature?

@kezhenxu94

Copy link
Copy Markdown
Member

We might also need a doc for the profiling feature?

After we release 0.7.0, @Humbertzhang will submit one for this

@wu-sheng

Copy link
Copy Markdown
Member

We have a blog draft for it actually.

@kezhenxu94 kezhenxu94 merged commit a6d351e into apache:master Sep 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants