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: Update docs for monorepo changes #83

Merged
merged 10 commits into from
Oct 21, 2022
Merged

Docs: Update docs for monorepo changes #83

merged 10 commits into from
Oct 21, 2022

Conversation

jackw
Copy link
Collaborator

@jackw jackw commented Oct 19, 2022

This PR does the following:

  • Changes the references in readme and other files from create-plugin to plugin-tools
  • Improves on contributing guide to help community understand expectations, workflows and how to contribute
  • Adds specific contributing guides for each package
  • Introduces PULL_REQUEST and ISSUE_TEMPLATES and adds config so new features are discussions

@jackw jackw mentioned this pull request Oct 19, 2022
5 tasks
@jackw jackw self-assigned this Oct 20, 2022
@jackw jackw added the type/docs Changes only affect the documentation label Oct 20, 2022
@jackw jackw marked this pull request as ready for review October 20, 2022 10:34
**Environment**:

<!--
Please run `npx envinfo --system --binaries --browsers --npmPackages="@grafana/*"` where you are experiencing the bug and paste the results here.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The command mentioned here will output the following:

  System:
    OS: macOS 12.6
    CPU: (8) x64 Intel(R) Core(TM) i5-1038NG7 CPU @ 2.00GHz
    Memory: 76.14 MB / 16.00 GB
    Shell: 5.8.1 - /bin/zsh
  Binaries:
    Node: 16.17.1 - ~/.nvm/versions/node/v16.17.1/bin/node
    Yarn: 1.22.19 - /usr/local/bin/yarn
    npm: 8.15.0 - ~/.nvm/versions/node/v16.17.1/bin/npm
  Browsers:
    Chrome: 106.0.5249.119
    Firefox: 104.0.2
    Safari: 16.0
  npmPackages:
    @grafana/data: latest => 9.2.0
    @grafana/toolkit: latest => 9.2.0
    @grafana/ui: latest => 9.2.0

@@ -0,0 +1,25 @@
---
name: Bug report
about: Report a bug you found
Copy link
Member

Choose a reason for hiding this comment

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

Given this is a mono-repo. We can add a field for project or package name. e.g.: create-plugin, sign-plugin and other upcoming tools.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I've migrated to using github forms for this issue template.

@@ -1,42 +1,149 @@
# Contributing to Grafana / Create Plugin
# Contributing
Copy link
Member

Choose a reason for hiding this comment

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

We should include something about the CLA here.

@academo
Copy link
Member

academo commented Oct 20, 2022

This is great! thanks for updating all these docs and adding even more.

Only one question, do we also need to update the repository field in the several package.json?

"repository": "git@github.com:grafana/create-plugin.git",
"url": "git@github.com:grafana/create-plugin.git"
"url": "git@github.com:grafana/create-plugin.git"

Copy link
Member

@academo academo left a comment

Choose a reason for hiding this comment

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

Thanks for putting this together

@jackw jackw merged commit 671c165 into main Oct 21, 2022
@jackw jackw deleted the jackw/update-docs branch October 21, 2022 08:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Changes only affect the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants