PalisadoesFoundation / talawa-docs

Documentation for Talawa and Talawa-API
https://docs.talawa.io/
GNU General Public License v3.0
44 stars 146 forks source link

Adding docs for end user perspective regarding the overview and usage of plugins. #671

Closed SiddheshKukade closed 7 months ago

SiddheshKukade commented 1 year ago

Is your feature request related to a problem? Please describe. Currently, our documentation lacks comprehensive information on the overview and usage of plugins from an end user's perspective. Users are finding it challenging to understand how plugins function within our system.

Describe the solution you'd like I propose creating detailed documentation that provides an end user perspective on the overview and usage of plugins. This documentation should include step-by-step guides, examples, and explanations of how plugins integrate with our system. This will empower users to effectively utilize the plugin capabilities without confusion.

Describe alternatives you've considered We've considered conducting video tutorials, but they might not cater to all learning preferences and may become outdated quickly. Another option was to rely solely on developer-oriented documentation, but this might not resonate well with users who lack technical expertise.

Approach to be followed (optional) Overview Section: Begin with a high-level explanation of what plugins are and their importance within our system. Installation and Setup: Provide detailed instructions on how to install, activate, and set up plugins, catering to users of varying technical levels. Usage Guides: Create step-by-step guides for the most common use cases of plugins. Use screenshots and examples to enhance clarity. Integration Possibilities: Highlight how plugins can be combined for more advanced functionalities, showcasing the flexibility of our system. Troubleshooting: Include a section dedicated to common issues users might face and how to troubleshoot them. Best Practices: Suggest best practices for choosing, managing, and updating plugins effectively.

Additional context Given the current lack of clear plugin documentation, users often reach out to support with queries related to plugin usage. This creates a strain on our support resources and can lead to user frustration. Having well-structured documentation will not only address user concerns but also enhance their overall experience with our system.

Potential internship candidates Please read this if you are planning to apply for a Palisadoes Foundation internship https://github.com/PalisadoesFoundation/talawa/issues/359

SiddheshKukade commented 1 year ago

I'm working on this.

github-actions[bot] commented 1 year ago

This issue did not get any activity in the past 10 days and will be closed in 180 days if no update occurs. Please check if the develop branch has fixed it and report again or close the issue.

SiddheshKukade commented 10 months ago

Working on it

SiddheshKukade commented 10 months ago

While working on this, I've found out the docusaurs in not compiling. After installing and doing yarn start it runs and then generates a long output error

Screenshot 2023-11-17 at 9 55 06 PM

I've also created a issue here: https://github.com/facebook/docusaurus/issues/9563

Waiting for their reply. I've tried on different platforms and the problem is the same. I'd add these docs as soon as this error is fixed

// cc @palisadoes @tasneemkoushar

github-actions[bot] commented 10 months ago

This issue did not get any activity in the past 10 days and will be closed in 180 days if no update occurs. Please check if the develop branch has fixed it and report again or close the issue.

palisadoes commented 10 months ago

@SiddheshKukade Are you still working on this?

SiddheshKukade commented 10 months ago

@palisadoes yes sir, the error is finally fixed. I'm adding the docs.

github-actions[bot] commented 10 months ago

This issue did not get any activity in the past 10 days and will be closed in 180 days if no update occurs. Please check if the develop branch has fixed it and report again or close the issue.

palisadoes commented 10 months ago

@SiddheshKukade Are you still working on this? It's been some time.

github-actions[bot] commented 9 months ago

This issue did not get any activity in the past 10 days and will be closed in 180 days if no update occurs. Please check if the develop branch has fixed it and report again or close the issue.

anshikavashistha commented 9 months ago

I want to work on this issue .Could you please assign me?

SiddheshKukade commented 9 months ago

@anshikavashistha I'm on it. Would add a PR in the night

github-actions[bot] commented 8 months ago

This issue did not get any activity in the past 10 days and will be closed in 180 days if no update occurs. Please check if the develop branch has fixed it and report again or close the issue.

Cioppolo14 commented 8 months ago

@SiddheshKukade Are you working on this?

github-actions[bot] commented 8 months ago

This issue did not get any activity in the past 10 days and will be closed in 180 days if no update occurs. Please check if the develop branch has fixed it and report again or close the issue.

palisadoes commented 8 months ago

@SiddheshKukade

Are you still working on this? This has been outstanding for some time. It's valuable documentation for the repositories.

neeraj542 commented 8 months ago

@SiddheshKukade Are you working on this? I'm interested in working on it.

Cioppolo14 commented 8 months ago

Unassigning due to lack of activity and PR.

Cioppolo14 commented 8 months ago

@neeraj542 You have been assigned.

neeraj542 commented 8 months ago

Thank you @Cioppolo14 for assigning this issue.

neeraj542 commented 8 months ago
image

@Cioppolo14 could you please help in join Slack as I don't have this email?

Cioppolo14 commented 8 months ago

@neeraj542 If you don't have a gmail or apple login, I can try to send you an invitation if you provide me your email address.

Cioppolo14 commented 8 months ago

@neeraj542 Try again, it should work now.

Cioppolo14 commented 8 months ago

@neeraj542 Try our Slack link again, and see if it works now.

neeraj542 commented 8 months ago

@Cioppolo14 Yes, now I am in. Thank you for giving me your valuable time.

Cioppolo14 commented 8 months ago

@neeraj542 No problem, I am here to help as I can. Thanks for being part of the community!

neeraj542 commented 8 months ago

After installing talawa-docs on my machine, I noticed some responsiveness issues on mobile versions related to certain images. Could you please confirm if I can address these here? @Cioppolo14

Screenshot 2024-02-03 115246 Screenshot 2024-02-03 115301 Screenshot 2024-02-03 115318
palisadoes commented 8 months ago

We not going to modify the site design.

github-actions[bot] commented 7 months ago

This issue did not get any activity in the past 10 days and will be closed in 180 days if no update occurs. Please check if the develop branch has fixed it and report again or close the issue.

Cioppolo14 commented 7 months ago

@neeraj542 Are you still working on this?

Cioppolo14 commented 7 months ago

Unassigning due to no activity or open PR.

github-actions[bot] commented 7 months ago

This issue did not get any activity in the past 10 days and will be closed in 180 days if no update occurs. Please check if the develop branch has fixed it and report again or close the issue.

palisadoes commented 7 months ago

Closing due to inactivity