pulsar icon indicating copy to clipboard operation
pulsar copied to clipboard

[Doc] Fix links to Google docs page in the documentation guide

Open tisonkun opened this issue 3 years ago • 2 comments

Search before asking

  • [X] I searched in the issues and found nothing similar.

What issue do you find in Pulsar docs?

There are still several links to Google Docs at https://pulsar.apache.org/contribute/documentation/overview

What is your suggestion?

Replace with links to the corresponding doc site files.

Any reference?

Subtask of #18272.

Are you willing to submit a PR?

  • [ ] I'm willing to submit a PR!

tisonkun avatar Nov 02 '22 09:11 tisonkun

Well. I notice that these three files are still not ported to a markdown file:

cc @Anonymitaet do you have a plan to migrate them? For example:

  1. Pulsar API Documentation Guide can be merged with Documentation Contribution Guide as the latter contains a section talking about the api/reference page.
  2. Pulsar Design Style Guide may be merged into the syntax guide or be ported as a lightweight new page.
  3. Pulsar Documentation Writing Style Guide seems a heavyweight page to migrate.

tisonkun avatar Nov 02 '22 09:11 tisonkun

  1. Pulsar API Documentation Guide can be ignored temporarily since it does not have much content. I'll add more content if I have more in the future.

  2. Pulsar Design Style Guide should be a separate guide on an independent page, it has nothing to do with the syntax guide.

  3. Yes, it's a large one and updated continuously.

Anonymitaet avatar Nov 03 '22 01:11 Anonymitaet

The issue had no activity for 30 days, mark with Stale label.

github-actions[bot] avatar Dec 03 '22 01:12 github-actions[bot]

This can be referred to https://github.com/apache/pulsar/issues/13288. I'm trying to pick up this issue in this month.

tisonkun avatar May 14 '23 10:05 tisonkun

The issue had no activity for 30 days, mark with Stale label.

github-actions[bot] avatar Jun 14 '23 02:06 github-actions[bot]

https://github.com/apache/pulsar/issues/18272#issuecomment-2053889607

tisonkun avatar Apr 14 '24 03:04 tisonkun