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

feat(docs): add community extensions page #5707

Merged
merged 1 commit into from
Jul 16, 2020
Merged

feat(docs): add community extensions page #5707

merged 1 commit into from
Jul 16, 2020

Conversation

dhmlau
Copy link
Member

@dhmlau dhmlau commented Jun 10, 2020

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:
Screen Shot 2020-06-09 at 11 05 24 PM

Checklist

👉 Read and sign the CLA (Contributor License Agreement) 👈

  • npm test passes on your machine
  • New tests added or existing tests modified to cover all changes
  • Code conforms with the style guide
  • API Documentation in code was updated
  • Documentation in /docs/site was updated
  • Affected artifact templates in packages/cli were updated
  • Affected example projects in examples/* were updated

👉 Check out how to submit a PR 👈

@dhmlau
Copy link
Member Author

dhmlau commented Jun 10, 2020

cc @samarpanB

@dhmlau dhmlau added the Docs label Jun 10, 2020
@dhmlau dhmlau self-assigned this Jun 10, 2020
@dhmlau
Copy link
Member Author

dhmlau commented Jun 11, 2020

@slnode test please

<td>Implement HRBAC authorization</td>
</tr>
</tbody>
<table>
Copy link
Member

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

@bajtos
Copy link
Member

bajtos commented Jun 12, 2020

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.

@dhmlau
Copy link
Member Author

dhmlau commented Jun 14, 2020

Sure. I'm good with either way.

@raymondfeng
Copy link
Contributor

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.

It might be beyond technical perspectives. From the legal/IP angle, I don't think we have the clearance to embed community work on loopback.io without CLA in place.

@dhmlau
Copy link
Member Author

dhmlau commented Jun 19, 2020

It might be beyond technical perspectives. From the legal/IP angle, I don't think we have the clearance to embed community work on loopback.io without CLA in place.

That's a good point. Thanks @raymondfeng for the reminder.
@bajtos, in this case, are you good to land this PR in the current form? If yes, I'll take care of the conflicting changes in the sidebar file. Thanks.

@samarpanB
Copy link
Contributor

@dhmlau is this PR still ON or it has been put on hold ?

@dhmlau
Copy link
Member Author

dhmlau commented Jul 6, 2020

@bajtos, are you good to land this PR in the current form (with resolving conflicting files)? Thanks.

@dhmlau dhmlau force-pushed the comm-ext branch 2 times, most recently from d1b2e2e to 2f8e39b Compare July 6, 2020 23:30
@dhmlau dhmlau requested review from jannyHou and bajtos July 6, 2020 23:30
@dhmlau
Copy link
Member Author

dhmlau commented Jul 6, 2020

Since there's restructuring of the sidebar, it might be the best to get reviews from the team again. Thanks.
cc @bajtos @jannyHou

Copy link
Contributor

@jannyHou jannyHou left a 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.

docs/site/Community-extensions.md Outdated Show resolved Hide resolved
@bajtos
Copy link
Member

bajtos commented Jul 13, 2020

are you good to land this PR in the current form (with resolving conflicting files)? Thanks.

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).

@dhmlau
Copy link
Member Author

dhmlau commented Jul 16, 2020

@bajtos, I moved the community extension page after the Extending LoopBack 4 section. It seems to be a more natural flow to me. PTAL. Thanks.

Copy link
Member

@bajtos bajtos left a comment

Choose a reason for hiding this comment

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

👏

@dhmlau dhmlau merged commit 98a7b96 into master Jul 16, 2020
@dhmlau dhmlau deleted the comm-ext branch July 16, 2020 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] Add a Community extension page
5 participants