Skip to content

Add doc guide for developing a new view type#344

Merged
PatrickTasse merged 1 commit into
eclipse-cdt-cloud:masterfrom
PatrickTasse:newview
Oct 9, 2025
Merged

Add doc guide for developing a new view type#344
PatrickTasse merged 1 commit into
eclipse-cdt-cloud:masterfrom
PatrickTasse:newview

Conversation

@PatrickTasse

@PatrickTasse PatrickTasse commented Aug 19, 2025

Copy link
Copy Markdown
Contributor

What it does

Add doc guide for developing a new view type

How to test

N/A

Follow-ups

N/A

Review checklist

  • As an author, I have thoroughly tested my changes and carefully followed the instructions in this template

Comment thread doc/Develop-new-view.md Outdated
The data provider's role is to provide a model corresponding to the requested method and parameters, possibly by scheduling an analysis and querying its resulting output, or any other method to extract data from the trace and compute the appropriate result.

## Data Provider Factory / Descriptor

@bhufmann bhufmann Aug 25, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The guide below is specific for the Trace Compass server. I wonder if this should be part of the trace server specific developer guide: https://github.com/eclipse-tracecompass/org.eclipse.tracecompass/blob/master/doc/trace-server/trace-server-dev-guide.md?

I recognize that the documentation for the Trace Compass is already scattered, for example, the referenced trace server guide above has specifics for Trace Compass core AND the trace server service layer which probably should be in the repo with the trace server code. Not sure how we should handle best full-stack development that affects different layers.

I also realized that it would be hard for someone else that doesn't use the Trace Compass server to propose changes to the TSP, because the TSP yaml is generated by the Trace Compass server.

Suggestions for improving the situation are welcome.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think it's ok to merge it and then improve on top of this version if needed. It's good to have this documentation.

QueryParameters queryParameters) {
```

## TSP Typescript Client

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Here the FE changes are outlined for a new view type. First the protocol level.

Comment thread doc/Develop-new-view.md Outdated
@MatthewKhouzam

Copy link
Copy Markdown
Contributor

Any updates?

Signed-off-by: Patrick Tasse <patrick.tasse@gmail.com>
@PatrickTasse PatrickTasse changed the title Add doc guide for developing a new view Add doc guide for developing a new view type Oct 7, 2025

@bhufmann bhufmann left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good to me. I'll link to this guide from #355. Thanks!

@PatrickTasse PatrickTasse merged commit 71de391 into eclipse-cdt-cloud:master Oct 9, 2025
7 of 9 checks passed
@PatrickTasse PatrickTasse deleted the newview branch October 9, 2025 14:05
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.

4 participants