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

Update instructions to set up trace server #711

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

hoangphamEclipse
Copy link
Contributor

The current instructions to set up the trace server for the trace extension does not explicitly indicate steps that only apply to Linux users. In addition, the lack of clear instructions for manually downloading and setting up the trace server makes it difficult for developers, who uses other OS, to run the trace server. This commit improves the documentation by providing clear instructions for developers on how to set up the server either by (1) using yarn, (2) downloading the server manually, or (3) building server manually. This will help contributors speed up their installation process, and reduce support effort.

@hoangphamEclipse hoangphamEclipse force-pushed the update-doc branch 4 times, most recently from d10a4a2 to 904dbda Compare August 10, 2022 16:04
The current instructions to set up the trace server for
the trace extension does not explicitly indicate steps that
only apply to Linux users. In addition, the lack of clear
instructions for manually downloading and setting up the trace
server makes it difficult for developers, who uses other OS,
to run the trace server. This commit improves the documentation
by providing clear instructions for developers on how to set
up the server either by (1) using yarn, (2) downloading the
server manually, or (3) building server manually. This will
help contributors speed up their installation process, and
reduce support effort.

Signed-off-by: Hoang Thuan Pham <hoang.pham@calian.ca>
@hoangphamEclipse
Copy link
Contributor Author

@bhufmann Just letting you know that this PR is updated.

You can also build the trace-server yourself using Trace Compass and the Incubator. Take a look at the [instructions here][tc-server-build].
Please note that you need a Trace Server Build before starting the server. See [Getting a Trace Server build][tc-server-download-guide] for more details. You will need to stop the server manually as well.

#### Starting the Trace Server from the Theia application
Copy link
Collaborator

Choose a reason for hiding this comment

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

In this chapter you should describe the preference setting for the trace server. User can change it to point to point to a custom trace server.

Copy link
Collaborator

@bhufmann bhufmann left a comment

Choose a reason for hiding this comment

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

I just noticed your updates. Please describe the trace server related preferences and that it will be used when starting the server from inside the application.

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.

2 participants