Skip to content

[doc][client feature matrix] improve experience for .NET users looking for information on .NET/C# clients#754

Merged
tisonkun merged 2 commits intoapache:mainfrom
jak78:main
Dec 18, 2023
Merged

[doc][client feature matrix] improve experience for .NET users looking for information on .NET/C# clients#754
tisonkun merged 2 commits intoapache:mainfrom
jak78:main

Conversation

@jak78
Copy link
Contributor

@jak78 jak78 commented Dec 17, 2023

This PR aims to improve the experience for .NET/C# users looking for information on .NET/C# clients. The goal is to help the users choose which client best suits their needs.

Two .NET clients exist: C#/DotPulsar and .NET client. They don't provide the same feature coverage. The PR fixes the client features matrix to display the two clients side by side to highlight this coverage difference.

Additionally, the PR adds a link to the client docs to facilitate the navigation and help the user compare the two clients in details.

Finally, the PR makes the doc use the same names for the clients in both the feature matrix and the client libraries page to improve clarity.

Preview:

Screenshot 2023-12-18 at 3 33 49 PM
  • doc
  • doc-required
  • doc-not-needed
  • doc-complete

@github-actions github-actions bot added the doc Improvements or additions to documentation label Dec 17, 2023
tableview,
} from "../data/matrix.js";

To get more information on clients, see [Pulsar Client Libraries](/docs/next/client-libraries).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
To get more information on clients, see [Pulsar Client Libraries](/docs/next/client-libraries).
To get more information on clients, see [Pulsar Client Libraries](/docs/client-libraries).

Let's use latest stable version.

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 tried that, but it results in a 404 error

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Looks like you can remove the next part from the links on the md pages but not on the mdx pages

Copy link
Member

Choose a reason for hiding this comment

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

it results in a 404 error

The redirect happens in Apache Web Server. So perhaps you need run docker-compose for previewing this manner ..

RewriteRule "^docs/(.*)$" "/docs/3.1.x/$1" [R=301,DPI,L]

https://github.com/apache/pulsar-site/blob/main/docker-compose.yaml

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Same result using docker compose

Copy link
Member

Choose a reason for hiding this comment

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

Well. I'll merge as is now.

@tisonkun tisonkun merged commit 8392ac3 into apache:main Dec 18, 2023
@jak78
Copy link
Contributor Author

jak78 commented Dec 18, 2023

Thank you @tisonkun

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants