-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
feat(docs): add community extensions page #5707
Conversation
cc @samarpanB |
@slnode test please |
<td>Implement HRBAC authorization</td> | ||
</tr> | ||
</tbody> | ||
<table> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add instructions on how can extension authors contribute their extensions to our list. Feel free to open a follow-up pull request for that.
You can inspire in our existing docs for contributing LB3 extensions: https://loopback.io/doc/en/community/How-to-add-a-project.html
On the second thought and in the light of #5718, I am not sure if it is a good idea to have a page listing community components. As a LoopBack user looking for a solution to my problem, I would not know that I have to look at the list of community extensions. I think a better option is to treat community extensions as first-class problem solutions and list them alongside the "official" extensions, using the README-sourcing mechanism we already have in place (see README layout). We can introduce a front-matter flag to mark an extension as community-maintained and update our README layout template to add a small notice at the top of the page to explain that the extension is not maintained by us. |
Sure. I'm good with either way. |
It might be beyond technical perspectives. From the legal/IP angle, I don't think we have the clearance to embed community work on |
That's a good point. Thanks @raymondfeng for the reminder. |
@dhmlau is this PR still ON or it has been put on hold ? |
@bajtos, are you good to land this PR in the current form (with resolving conflicting files)? Thanks. |
d1b2e2e
to
2f8e39b
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One nitpick, LGTM 👍 And happy to see the auth extensions.
I am fine to add a new page for community extensions based on the discussion above. IIUC, you are proposing to add the new page "Community extensions" to the "How-to guides" section of the sidebar. I feel that's not the best location - personally, I would not look for community extensions there. I am proposing to convert "Community extensions" into a first-level entry and place it between "Reference guides" and "Extending LoopBack 4" (of further down in the list). |
@bajtos, I moved the community extension page after the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👏
Fixes #5702
Add a community extensions page with some of the extensions we know about. The intention of this page is to have community adding their own extensions there.
Preview of the change:
Checklist
👉 Read and sign the CLA (Contributor License Agreement) 👈
npm test
passes on your machinepackages/cli
were updatedexamples/*
were updated👉 Check out how to submit a PR 👈