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

Add overview page to show service description in DocService #4537

Merged
merged 4 commits into from Dec 19, 2022

Conversation

Dogacel
Copy link
Contributor

@Dogacel Dogacel commented Nov 14, 2022

Motivation:

Currently no page shows service description / documentation info.

Modifications:

  • Update tooltip on service name to include service description.
  • Add an overview page to the top level services dropdown too see all services and their descriptions in a single page.

Result:

Screenshot 2022-11-15 at 01 23 50

Screenshot 2022-11-15 at 01 22 17

Screenshot 2022-11-15 at 01 01 21

@codecov
Copy link

codecov bot commented Nov 16, 2022

Codecov Report

Base: 74.08% // Head: 74.07% // Decreases project coverage by -0.00% ⚠️

Coverage data is based on head (4e029bd) compared to base (b127cd2).
Patch coverage: 89.01% of modified lines in pull request are covered.

Additional details and impacted files
@@             Coverage Diff              @@
##             master    #4537      +/-   ##
============================================
- Coverage     74.08%   74.07%   -0.01%     
+ Complexity    18190    18180      -10     
============================================
  Files          1537     1537              
  Lines         67432    67469      +37     
  Branches       8533     8537       +4     
============================================
+ Hits          49959    49980      +21     
- Misses        13401    13414      +13     
- Partials       4072     4075       +3     
Impacted Files Coverage Δ
...a/com/linecorp/armeria/server/docs/DocService.java 90.66% <89.01%> (-3.14%) ⬇️
...inecorp/armeria/common/ClosedSessionException.java 54.54% <0.00%> (-18.19%) ⬇️
...p/armeria/client/AggregatedHttpRequestHandler.java 82.35% <0.00%> (-8.83%) ⬇️
...rnal/common/GracefulConnectionShutdownHandler.java 68.08% <0.00%> (-6.39%) ⬇️
...eria/internal/common/stream/StreamMessageUtil.java 61.11% <0.00%> (-5.56%) ⬇️
...m/linecorp/armeria/client/DecodedHttpResponse.java 85.00% <0.00%> (-5.00%) ⬇️
...orp/armeria/client/AbstractHttpRequestHandler.java 79.84% <0.00%> (-4.66%) ⬇️
...easy/ResteasyAsynchronousExecutionContextImpl.java 53.48% <0.00%> (-2.33%) ⬇️
...rmeria/common/stream/ConcatArrayStreamMessage.java 83.14% <0.00%> (-2.25%) ⬇️
.../linecorp/armeria/client/Http2ResponseDecoder.java 68.53% <0.00%> (-2.10%) ⬇️
... and 16 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Contributor

@jrhee17 jrhee17 left a comment

Choose a reason for hiding this comment

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

Looks great! Left some minor comments 👍

docs-client/src/containers/App/index.tsx Outdated Show resolved Hide resolved
docs-client/src/containers/App/index.tsx Outdated Show resolved Hide resolved
docs-client/src/containers/App/index.tsx Outdated Show resolved Hide resolved
@Dogacel Dogacel requested review from jrhee17 and removed request for trustin, ikhoon and minwoox November 18, 2022 21:58
docs-client/src/containers/App/index.tsx Outdated Show resolved Hide resolved
data.map((service) => (
<TableRow key={service.name}>
<TableCell>
<code>{service.name}</code>
Copy link
Contributor

Choose a reason for hiding this comment

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

This is so nice. How about adding a hashtag to each service name and linking to the tag?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I did not get this, how do I add a hashtag to each service name, and where it would link?

Copy link
Contributor

Choose a reason for hiding this comment

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

I thought we can add a tag to this line.

<div key={service.name}>

Anyway, never mind. It looks good as is. We may add a dedicated page for each service that may be linked from this overview page later.

@Dogacel
Copy link
Contributor Author

Dogacel commented Dec 15, 2022

Bump

Copy link
Contributor

@ikhoon ikhoon left a comment

Choose a reason for hiding this comment

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

Thank you so much! 🚀👍

@ikhoon ikhoon added this to the 1.21.0 milestone Dec 16, 2022
Copy link
Contributor

@jrhee17 jrhee17 left a comment

Choose a reason for hiding this comment

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

Nice! Thanks @Dogacel 🙇 🙇 🙇

Copy link
Member

@minwoox minwoox left a comment

Choose a reason for hiding this comment

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

What a nice!
Thanks, @Dogacel! 😄

@minwoox minwoox changed the title add overview page Add overview page to show service description in DocService Dec 19, 2022
@minwoox minwoox merged commit 3c17931 into line:master Dec 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DocService GRPC Service comments are not displayed anywhere
4 participants