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

[GSOC]Docs : Plugin Architecture Overview Page #254

Merged
merged 4 commits into from
Nov 17, 2022

Conversation

SiddheshKukade
Copy link
Member

@SiddheshKukade SiddheshKukade commented Nov 12, 2022

This Pull Request is associated with Google Summer of Code 2022 Project link

What kind of change does this PR introduce?
Docs : Plugin Architecture Overview Page

Issue Number:

Fixes #251

Did you add tests for your changes?
Not required

Snapshots/Videos:
Will be added soon

If relevant, did you update the documentation?
Yes
Summary
Added

  • Overview of What a plugin actually means in talawa repositories

  • A High-level diagram to describe workflow with description

  • code explanation

Does this PR introduce a breaking change?

No

Have you read the contributing guide?

Yes

OUTPUT :

Output 1
output 2
output 3
output 4

@SiddheshKukade
Copy link
Member Author

I Would like to have Initial review from mentors for suggestions

@DMills27
Copy link
Member

Looks good so far. You need to add more details in the different sections specifically the Talawa API section. Also, it's good you provided actual examples but you also should write about how someone could integrate their code as a plugin. For example, if we wanted to refactor the spam filter as a plugin what would be needed? What is the process of refactoring it?

@SiddheshKukade SiddheshKukade marked this pull request as ready for review November 12, 2022 12:49
@SiddheshKukade
Copy link
Member Author

SiddheshKukade commented Nov 12, 2022

Thank you @DMills27 Sir for the review! Actually, I've created this page just for the introduction of the Plugin Architecture So that It would not be too complex.
To explain the detailed Plugin creation process and Converting features to plugins and the example you have mentioned. I will create separate pages to describe them in depth.
So that the docs would be more well structured.

What do you think about this approach?

@SiddheshKukade
Copy link
Member Author

@DMills27 Sir, I've also updated the first comment with the screenshots and the pull request is now ready to be reviewed.
I've added this short video in the installation example to show the plugins in action.

Plugin.Architecture.Demo.-.Installation.of.Plugin.from.store.mp4

Please suggest improvements, thanks 👍🏻

Copy link
Member

@DMills27 DMills27 left a comment

Choose a reason for hiding this comment

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

The new changes have provided easy to follow instructions and a clear overview. The video that you also added in the PR is not entirely clear at the moment but that can be fixed later on.

@palisadoes palisadoes merged commit e7d05f5 into PalisadoesFoundation:master Nov 17, 2022
@SiddheshKukade SiddheshKukade changed the title Docs : Plugin Architecture Overview Page [GSOC]Docs : Plugin Architecture Overview Page Nov 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature Request : Adding Plugin Architecture Overview Page
4 participants