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

docs(v2): Include docusaurus-protobuffet to community plugins #4594

Merged
merged 1 commit into from
Apr 11, 2021

Conversation

AnthonyBobsin
Copy link
Contributor

@AnthonyBobsin AnthonyBobsin commented Apr 10, 2021

Motivation

As a member of a team that works with Protobuf contracts, we have a need for developer-driven documentation that satisfies both the consumers and builders of APIs driven by these contracts. This documentation should be driven by the Protobuf contracts they document, while being extensible with human-provided context.

We already use Docusaurus at my organization for JSON APIs, but we lack the tooling required to document RPC services backed by Protobuf contracts. I've decided to leverage the Docusaurus plugin framework to provide this tooling.

Protobuffet is a Docusaurus preset that generates doc files using Protobuf contracts. In this PR, I'm including this preset in the Community Plugins section of the docs. Check out the Protobuffet docs for more info on this toolset.

Example Screenshot

Have you read the Contributing Guidelines on pull requests?

Yes.

@facebook-github-bot
Copy link
Contributor

Hi @AnthonyBobsin!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

@netlify
Copy link

netlify bot commented Apr 10, 2021

@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Apr 10, 2021
@github-actions
Copy link

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 74
🟢 Accessibility 96
🟢 Best practices 100
🟢 SEO 100
🟢 PWA 95

Lighthouse ran on https://deploy-preview-4594--docusaurus-2.netlify.app/

@slorber slorber changed the title docs: Include docusaurus-protobuffet to community plugins docs(v2): Include docusaurus-protobuffet to community plugins Apr 11, 2021
@slorber slorber added the pr: documentation This PR works on the website or other text documents in the repo. label Apr 11, 2021
@slorber
Copy link
Collaborator

slorber commented Apr 11, 2021

thanks 👍

@slorber slorber merged commit 4c09249 into facebook:master Apr 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants