search

protocolbuffers / protobuf

Protocol Buffers - Google's data interchange format
http://protobuf.dev
Other
65.14k stars 15.44k forks source link

Some documentation links are broken #14141

Open alexolog opened 11 months ago

alexolog commented 11 months ago

What version of protobuf and what language are you using?

N/A - The issue relates to the online documentation on https://protobuf.dev/

What operating system (Linux, Windows, ...) and version?

N/A - The issue relates to the online documentation on https://protobuf.dev/

What runtime / compiler are you using (e.g., python version or gcc version)

N/A - The issue relates to the online documentation on https://protobuf.dev/

What did you do? Steps to reproduce the behavior:

  1. Go to an online documentation page.
  2. Click on the Descriptor link in this sentence "This method REQUIRES that the two messages have the same Descriptor (message1.GetDescriptor() == message2.GetDescriptor())."
  3. See the 404 error.

What did you expect to see

The link should point to https://protobuf.dev/reference/cpp/api-docs/google.protobuf.descriptor/#Descriptor.

What did you see instead?

The link points to https://protobuf.dev/reference/cpp/api-docs/google.protobuf.util.message_differencer/google.protobuf.descriptor#Descriptor, which does not exist.

Anything else we should know

It looks like Doxygen generates the wrong links when they point to a different page. The google.protobuf.util.message_differencer part in the URL suggests that isn't told to go one level up.

This is just an example, the issue exists in other pages as well!

Logofile commented 11 months ago

Thanks for raising this issue and providing excellent steps to reproduce.

This is a known issue. We have made some improvements on the generated output since the issue was raised, but the full fix will require help from the SWE involved in the documentation generation process, and they're out of office on extended leave right now. I don't have an ETA for the full fix.

github-actions[bot] commented 8 months ago

We triage inactive PRs and issues in order to make it easier to find active work. If this issue should remain active or becomes active again, please add a comment.

This issue is labeled inactive because the last activity was over 90 days ago.

alexolog commented 8 months ago

It's been three months, has there been any progress?

Logofile commented 8 months ago

Unfortunately, no progress as of right now. We'll be looking at Q1 planning in the next week or two, and will assess this along with other docs tasks for priority.

ihtarlik commented 6 months ago

Since we're heading into Q2, I am wondering how low the priority is on this issue. I am working on a project and am needing the C# and Java API references for Protobuf.

Logofile commented 5 months ago

I wish I had better news on this front. Team leadership is aware that the broken links are impacting our users, and are trying to carve out developer time to fix the issue.

eltanardo commented 5 months ago

Hello, same problem with java API reference : https://protobuf.dev/reference/java/api-docs/overview-summary/ regards

github-actions[bot] commented 2 months ago

We triage inactive PRs and issues in order to make it easier to find active work. If this issue should remain active or becomes active again, please add a comment.

This issue is labeled inactive because the last activity was over 90 days ago.

Logofile commented 2 months ago

I'm keeping this open. I've got plans to implement a new build process this quarter. I'll start with Java, and move to other languages after that.