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.

Sign up for GitHub

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

Jump to bottom

added troubleshooting section to the readme file #592

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

added troubleshooting section to the readme file #592

wants to merge 1 commit into from
+27 −0

Conversation

vaishnavipal1869
Copy link

Description

This PR does the following:

  • Adds a troubleshooting section to the README file to assist users with common issues encountered during installation and server setup.
  • Provides FAQs to address frequent questions regarding the local database and support contact.

Related Issues

Changes

List the detailed changes made in this PR:

  • Added a new troubleshooting section covering:
    • Common installation issues
    • Problems with starting the server
    • Issues related to dependencies
    • Frequently asked questions (FAQs)

Testing Instructions

Detailed instructions on how to test the changes:

  1. Pull this branch.
  2. Check out the README file to review the newly added troubleshooting section.
  3. Ensure that the troubleshooting instructions accurately reflect common issues and provide clear resolutions.

Screenshots (if applicable)

  • not applicable.

Additional Context

  • This PR is based on the feedback received from users facing installation issues. The added troubleshooting section aims to streamline the onboarding process and reduce confusion for new users.

Checklist

Make sure to check off all the items before submitting:

  • I have performed a self-review of my code.
  • I have commented on my code, particularly in hard-to-understand areas.
  • My changes generate no new warnings.
  • I am working on this issue under GSSOC.

@github-actions GitHub Actions
Copy link

Thank you for submitting your pull request! 🙌 We'll review it as soon as possible. In the meantime, please ensure that your changes align with our CONTRIBUTING.md. If there are any specific instructions or feedback regarding your PR, we'll provide them here. Thanks again for your contribution! 😊

@Trisha-tech
Copy link
Owner

Description

This PR does the following:

  • Adds a troubleshooting section to the README file to assist users with common issues encountered during installation and server setup.
  • Provides FAQs to address frequent questions regarding the local database and support contact.

Related Issues

Changes

List the detailed changes made in this PR:

  • Added a new troubleshooting section covering:

    • Common installation issues
    • Problems with starting the server
    • Issues related to dependencies
    • Frequently asked questions (FAQs)

Testing Instructions

Detailed instructions on how to test the changes:

  1. Pull this branch.
  2. Check out the README file to review the newly added troubleshooting section.
  3. Ensure that the troubleshooting instructions accurately reflect common issues and provide clear resolutions.

Screenshots (if applicable)

  • not applicable.

Additional Context

  • This PR is based on the feedback received from users facing installation issues. The added troubleshooting section aims to streamline the onboarding process and reduce confusion for new users.

Checklist

Make sure to check off all the items before submitting:

  • I have performed a self-review of my code.
  • I have commented on my code, particularly in hard-to-understand aras.
  • My changes generate no new warnings.
  • I am working on this issue under GSSOC.

Kindly add some screenshot or screen recording of the features you have added. @vaishnavipal1869

@Suman373 Suman373 added documentation Improvements or additions to documentation enhancement New feature or request level1 gssoc-ext labels Oct 23, 2024
@Suman373
Copy link
Collaborator

@vaishnavipal1869 Add a screenshot of the troubleshooting section you have added in the markdown file.

@vaishnavipal1869
Copy link
Author

@vaishnavipal1869 Add a screenshot of the troubleshooting section you have added in the markdown file.

hello @Suman373 , Since my changes were purely related to documentation, I believe a screenshot may not be necessary in this case. However, if a screenshot is still required, I can provide one of the README file showing the updates. Please let me know how you'd prefer to proceed.

@Suman373
Copy link
Collaborator

@vaishnavipal1869 Add a screenshot of the troubleshooting section you have added in the markdown file.

hello @Suman373 , Since my changes were purely related to documentation, I believe a screenshot may not be necessary in this case. However, if a screenshot is still required, I can provide one of the README file showing the updates. Please let me know how you'd prefer to proceed.

Although you have made documentation changes, a screenshot for the updated markdown file especially your changes is necessary. I have checked it so you don't have to update the PR but make sure to add it from next time onwards. Anyway, nice work ! We look forward to more contributions from your side 👍

@Suman373
Copy link
Collaborator

@Trisha-tech you may verify and merge it

image

@vaishnavipal1869
Copy link
Author

@vaishnavipal1869 Add a screenshot of the troubleshooting section you have added in the markdown file.

hello @Suman373 , Since my changes were purely related to documentation, I believe a screenshot may not be necessary in this case. However, if a screenshot is still required, I can provide one of the README file showing the updates. Please let me know how you'd prefer to proceed.

Although you have made documentation changes, a screenshot for the updated markdown file especially your changes is necessary. I have checked it so you don't have to update the PR but make sure to add it from next time onwards. Anyway, nice work ! We look forward to more contributions from your side 👍

Apologies for not including the screenshots earlier. If you'd like, I can add them right away—just let me know how you'd like me to proceed. I appreciate the feedback and will make sure to include them in future updates

@Suman373
Copy link
Collaborator

@vaishnavipal1869 Add a screenshot of the troubleshooting section you have added in the markdown file.

hello @Suman373 , Since my changes were purely related to documentation, I believe a screenshot may not be necessary in this case. However, if a screenshot is still required, I can provide one of the README file showing the updates. Please let me know how you'd prefer to proceed.

Although you have made documentation changes, a screenshot for the updated markdown file especially your changes is necessary. I have checked it so you don't have to update the PR but make sure to add it from next time onwards. Anyway, nice work ! We look forward to more contributions from your side 👍

Apologies for not including the screenshots earlier. If you'd like, I can add them right away—just let me know how you'd like me to proceed. I appreciate the feedback and will make sure to include them in future updates

Its okay ! 😊

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@vaishnavipal1869 vaishnavipal1869

Labels
documentation Improvements or additions to documentation enhancement New feature or request gssoc-ext level1
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Documentation Update]: Add a Troubleshooting Section to README
3 participants
@vaishnavipal1869 @Trisha-tech @Suman373