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

Admin files Configuration #675

Closed Nitya-Pasrija closed 1 year ago

Nitya-Pasrija commented 1 year ago

What kind of change does this PR introduce? The files now being uploaded via the Talawa Admin TypeDoc workflow are integrated with this PR. Proper linking and configuration of these files is completed. This generates an automatic side nav and links the files together seamlessly.

Issue Number: Fixes #674

Snapshots/Videos: image

If relevant, did you update the documentation? Yes, an introduction file for Talawa Admin was created.

Summary Achieved design consistency and automation for documentation in the Admin section

Does this PR introduce a breaking change? No

Have you read the contributing guide? Yes

Nitya-Pasrija commented 1 year ago

Note: Do NOT merge this PR until the pre-PR for documentation generation in Talawa Admin: Pull request (https://github.com/PalisadoesFoundation/talawa-admin/pull/960) is merged.

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.
Nitya-Pasrija commented 1 year ago

@tasneemkoushar @noman2002 @palisadoes

palisadoes commented 1 year ago

Why is the deploy action failing?

Nitya-Pasrija commented 1 year ago

@palisadoes The workflow PR for the generation of Talawa Admin documentation hasn't been merged. Hence, the files will only be available when that is running.

palisadoes commented 1 year ago

What PR is that? Please ask your mentors to review it as a priority

Nitya-Pasrija commented 1 year ago

Note: Do NOT merge this PR until the pre-PR for documentation generation in Talawa Admin: Pull request (PalisadoesFoundation/talawa-admin#960) is merged.

This one

palisadoes commented 1 year ago

Note: Do NOT merge this PR until the pre-PR for documentation generation in Talawa Admin: Pull request (PalisadoesFoundation/talawa-admin#960) is merged.

This one

Thanks. Please work with @tasneemkoushar and @anwersayeed to approve and merge that one.

Nitya-Pasrija commented 1 year ago

Note: Do NOT merge this PR until the pre-PR for documentation generation in Talawa Admin: Pull request (PalisadoesFoundation/talawa-admin#960) is merged.

This one

Thanks. Please work with @tasneemkoushar and @anwersayeed to approve and merge that one.

No worries, I will contact them.

palisadoes commented 1 year ago

@Nitya-Pasrija The tests are also failing because the sidebar cannot be generated. Please review.

github-actions[bot] commented 1 year ago

This pull request did not get any activity in the past 10 days and will be closed in 180 days if no update occurs. Please verify it has no conflicts with the develop branch and rebase if needed. Mention it now if you need help or give permission to other people to finish your work.