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: add meta guidelines for new plugin development guides #27574

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

aramissennyeydd
Copy link
Contributor

Hey, I just made a Pull Request!

Adding some light guidelines on how to write docs for the plugin development guides following #27185. The goal here is to write these, a few guides and then start asking for contributions once we have a framework that new docs can fit into.

✔️ Checklist

  • A changeset describing the change and affected packages. (more info)
  • Added or updated documentation
  • Tests for new functionality and regression tests for bug fixes
  • Screenshots attached (for UI changes)
  • All your commits have a Signed-off-by line in the message. (more info)

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
@aramissennyeydd aramissennyeydd requested review from a team as code owners November 10, 2024 17:28
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 10, 2024
Copy link
Collaborator

@Parsifal-M Parsifal-M left a comment

Choose a reason for hiding this comment

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

Really cool! Just a few comments and suggestions! But I think this is an awesome start 👏

docs/plugins/guides/101/meta.md Outdated Show resolved Hide resolved
docs/plugins/guides/101/meta.md Outdated Show resolved Hide resolved
docs/plugins/guides/meta.md Outdated Show resolved Hide resolved
docs/plugins/guides/meta.md Outdated Show resolved Hide resolved
Copy link
Contributor

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

@github-actions github-actions bot added the stale label Nov 29, 2024
@Rugvip Rugvip removed the stale label Nov 30, 2024
aramissennyeydd and others added 3 commits November 29, 2024 22:13
Co-authored-by: Peter Macdonald <macdonald.peter90@gmail.com>
Signed-off-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com>
Co-authored-by: Peter Macdonald <macdonald.peter90@gmail.com>
Signed-off-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com>
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
Copy link
Collaborator

@Parsifal-M Parsifal-M left a comment

Choose a reason for hiding this comment

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

Looks good and makes sense from my side!

Not sure if we want @Rugvip to take a final pass 👀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants