search

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

Update: Add installation.md file #575

Closed Vic-Orlands closed 1 year ago

Vic-Orlands commented 1 year ago

What kind of change does this PR introduce? A bug.

Issue Number: #419

Fixes #419

Summary The talawa, talawa-admin and talawa-api repositories all have a standardized README.md file that refers to their respective INSTALLATION.md and CONTRIBUTING.md files. This is not the case with talawa-docs.

Also, many slack channel contributors kept asking questions about the installation. This is because npm produces an error page when you run the server locally. I took account of this bug when fixing the issue.

Solution I converted the README.md file to more closely match those of the other repositories. I created a table of content to show the steps and easily jump to the various sections.

Lastly, I removed any and all npm information that were redundant and replaced them with yarn.

Have you read the contributing guide? Yes

github-actions[bot] commented 1 year ago

Our Pull Request Approval Process

We have these basic policies to make the approval process smoother for our volunteer team.

Testing Your Code

Please make sure your code passes all tests and there are no merge conflicts.

The process helps maintain accurate and well-formatted documentation and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing.

Reviewers

When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. :dart: Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
Vic-Orlands commented 1 year ago

This PR should also change the README.md file to remove the installation information placed with installation.md.

I have removed the installation information from the README.md file