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

How to reflect changes done to proto buf in API reference docs #955

Open
ashikjm opened this issue Feb 21, 2025 · 6 comments · May be fixed by #964
Open

How to reflect changes done to proto buf in API reference docs #955

ashikjm opened this issue Feb 21, 2025 · 6 comments · May be fixed by #964

Comments

@ashikjm
Copy link

ashikjm commented Feb 21, 2025

When i regenerated the proto buf, it printed the following. Is this still to be followed? I am not able to find the next folder, so I am assuming the documentation is stale.

Ref Issue : etcd-io/etcd#18267
PR : etcd-io/etcd#19446

The API references have NOT been automatically published on the website.

To publish the API references, copy the following files
  - Documentation/dev-guide/api_reference_v3.md
  - Documentation/dev-guide/api_concurrency_reference_v3.md
to the etcd-io/website repo under the /content/en/docs/next/dev-guide/ folder.
etcdserver: Regenerate protobuf binding
(https://github.com/etcd-io/website/tree/main/content/en/docs/next/dev-guide)
@ivanvc
Copy link
Member

ivanvc commented Feb 22, 2025

Cross posting: etcd-io/etcd#19446 (comment)

The issue is that we don't have a next directory. We have v3.6. But if your pull request targets main, it shouldn't be in v3.6's documentation.

@ahrtr
Copy link
Member

ahrtr commented Feb 23, 2025

I recall the maintainers discussed this a couple of years before, but I lost the context now.

Two questions:

cc @ivanvc @jmhbnz @serathius @spzala

@ivanvc
Copy link
Member

ivanvc commented Feb 25, 2025

As far as I know, the answer to both questions is no. We'd need to write some automation to update the documentation, but we have been unsuccessful in these tasks because of GitHub permissions.

@ashikjm
Copy link
Author

ashikjm commented Feb 25, 2025

So currently if we have a pull request targetting 3.6 (etcd-io/etcd#19468), do I submit changes in documentation under the 3.6 folder?

@ivanvc
Copy link
Member

ivanvc commented Feb 26, 2025

So currently if we have a pull request targetting 3.6 (etcd-io/etcd#19468), do I submit changes in documentation under the 3.6 folder?

Yes, please. 🙏

@ashikjm
Copy link
Author

ashikjm commented Feb 27, 2025

I found a typo in the etcd v3election protobuf. Will fix that too and raise a single PR.

PR to fix typos : etcd-io/etcd#19498

@ashikjm ashikjm linked a pull request Feb 27, 2025 that will close this issue
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 a pull request may close this issue.

3 participants