Skip to content

Commit

Permalink
Fix: Venue details now update without requiring a name change (#3302)
Browse files Browse the repository at this point in the history
* implement a Visit button in the Joined Organizations filter

* Resolved: Potential Issue Identified by CodeRabbit AI

* Resolved: Potential Issue Identified by CodeRabbit AI

* Resolved: Potential Issue Identified by CodeRabbit AI

* Resolved: Potential Issue Identified by CodeRabbit AI

* Update src/components/OrganizationCard/OrganizationCard.tsx

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Added test cases

* Added test cases

* added tsdoc

* resolve: all issue

* Fix: Venue details now update without requiring a name change

* Improve Test Cases

* Add Codecov upload step

* removing changes from pull-request.yml

* New Tests for Uncovered Lines

* Added additional test cases

* Added additional test cases

* added comments in OrganizationCard.spec.tsx

* added test cases

* solved conflict files

* Update src/components/OrganizationCard/OrganizationCard.tsx

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Added test cases

* added tsdoc

* resolve: all issue

* Fix: Venue details now update without requiring a name change

* Improve Test Cases

* Add Codecov upload step

* removing changes from pull-request.yml

* New Tests for Uncovered Lines

* Added additional test cases

* Added additional test cases

* added comments in OrganizationCard.spec.tsx

* added test cases

* solved conflict files

* Resolved Conflict

* Resolved Conflict conflicting file

* Resolved Conflict conflicting file

* Resolved Conflict conflicting file

* Resolved Conflict conflicting file

* Resolved Conflict conflicting file

* Resolved Conflict conflicting file

* Resolved issue

* Resolved issue

* Resolved issue

* Solving Conflict files

* unchanging Sensitive files

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
  • Loading branch information
gkbishnoi07 and coderabbitai[bot] authored Jan 26, 2025
1 parent 006ee0f commit da20828
Show file tree
Hide file tree
Showing 9 changed files with 1,607 additions and 287 deletions.
35 changes: 20 additions & 15 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,32 @@
# Documentation

Welcome to our documentation guide. Here are some useful tips you need to know!

# Table of Contents

<!-- toc -->

- [Documentation](#documentation)
- [Table of Contents](#table-of-contents)
- [Where to find our documentation](#where-to-find-our-documentation)
- [Where to find our documentation](#where-to-find-our-documentation)
- [How to use Docusaurus](#how-to-use-docusaurus)
- [Other information](#other-information)

<!-- tocstop -->

## Where to find our documentation

Our documentation can be found in ONLY THREE PLACES:

1. **Inline within the repository's code files**:
1. We have automated processes to extract this information and place it in our Talawa documentation site [docs-admin.talawa.io](https://docs-admin.talawa.io/).
2. These are placed in the repository's Docusaurus sub-directory `docs/docs/auto-docs`
2. **In the repository's Docusaurus files**:
1. These include manually edited files from our contributors
2. These can be found in the `docs/docs/docs` directory
3. **In our `talawa-docs` repository**:
1. Our [Talawa-Docs](https://github.com/PalisadoesFoundation/talawa-docs) repository contains user edited markdown files that cover information across all the Talawa repositories.
2. That repository generates web pages for our Talawa documentation site [docs.talawa.io](https://docs.talawa.io/) using the [Docusaurus](https://docusaurus.io/) package.
Our documentation can be found in ONLY TWO PLACES:

1. ***Inline within the repository's code files***: We have automated processes to extract this information and place it in our Talawa documentation site [docs.talawa.io](https://docs.talawa.io/).
1. ***In our `talawa-docs` repository***: Our [Talawa-Docs](https://github.com/PalisadoesFoundation/talawa-docs) repository contains user edited markdown files that are automatically integrated into our Talawa documentation site [docs.talawa.io](https://docs.talawa.io/) using the [Docusaurus](https://docusaurus.io/) package.

## How to use Docusaurus
The process in easy:
1. Install `talawa-docs` on your system
1. Launch docusaurus on your system according to the `talawa-docs`documentation.
- A local version of `docs.talawa.io` should automatically launched in your browser at http://localhost:3000/
1. Add/modify the markdown documents to the `docs/` directory of the `talawa-docs` repository
1. If adding a file, then you will also need to edit the `sidebars.js` which is used to generate the [docs.talawa.io](https://docs.talawa.io/) menus.
1. Always monitor the local website in your brower to make sure the changes are acceptable.
- You'll be able to see errors that you can use for troubleshooting in the CLI window you used to launch the local website.

## Other information
***PLEASE*** do not add markdown files in this repository. Add them to `talawa-docs`!
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@

> **default**(): `Element`
Defined in: [src/components/SignOut/SignOut.tsx:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/SignOut/SignOut.tsx#L20)
Defined in: [src/components/SignOut/SignOut.tsx:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/SignOut/SignOut.tsx#L19)

Renders a sign-out button.
Renders a sign out button.

This component helps to log out.
This component helps to logout.
The logout function revokes the refresh token and clears local storage before redirecting to the home page.

## Returns

`Element`

JSX.Element - The sign-out button.
JSX.Element - The profile card .
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Defined in: [src/components/Venues/VenueModal.tsx:56](https://github.com/Palisad
A modal component for creating or updating venue information.

This component displays a modal window where users can enter details for a venue, such as name, description, capacity, and an image.
It also handles submitting the form data to create or update a venue based on whether the `edit` prop is true or false.
It also handles submitting the form data to create or update a venue based on whether the edit prop is true or false.

## Parameters

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
[Admin Docs](/)

***

# Variable: EMPTY\_MOCKS

> `const` **EMPTY\_MOCKS**: `object`[]
Defined in: [src/screens/OrganizationDashboard/Leaderboard/Leaderboard.mocks.ts:162](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/screens/OrganizationDashboard/Leaderboard/Leaderboard.mocks.ts#L162)

## Type declaration

### request

> **request**: `object`
#### request.query

> **query**: `DocumentNode` = `VOLUNTEER_RANKING`
#### request.variables

> **variables**: `object`
#### request.variables.orgId

> **orgId**: `string` = `'orgId'`
#### request.variables.where

> **where**: `object`
#### request.variables.where.nameContains

> **nameContains**: `string` = `''`
#### request.variables.where.orderBy

> **orderBy**: `string` = `'hours_DESC'`
#### request.variables.where.timeFrame

> **timeFrame**: `string` = `'allTime'`
### result

> **result**: `object`
#### result.data

> **data**: `object`
#### result.data.getVolunteerRanks

> **getVolunteerRanks**: `any`[] = `[]`
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
[Admin Docs](/)

***

# Variable: ERROR\_MOCKS

> `const` **ERROR\_MOCKS**: `object`[]
Defined in: [src/screens/OrganizationDashboard/Leaderboard/Leaderboard.mocks.ts:183](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/screens/OrganizationDashboard/Leaderboard/Leaderboard.mocks.ts#L183)

## Type declaration

### error

> **error**: `Error`
### request

> **request**: `object`
#### request.query

> **query**: `DocumentNode` = `VOLUNTEER_RANKING`
#### request.variables

> **variables**: `object`
#### request.variables.orgId

> **orgId**: `string` = `'orgId'`
#### request.variables.where

> **where**: `object`
#### request.variables.where.nameContains

> **nameContains**: `string` = `''`
#### request.variables.where.orderBy

> **orderBy**: `string` = `'hours_DESC'`
#### request.variables.where.timeFrame

> **timeFrame**: `string` = `'allTime'`
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
[Admin Docs](/)

***

# Variable: MOCKS

> `const` **MOCKS**: `object`[]
Defined in: [src/screens/OrganizationDashboard/Leaderboard/Leaderboard.mocks.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/screens/OrganizationDashboard/Leaderboard/Leaderboard.mocks.ts#L51)

## Type declaration

### request

> **request**: `object`
#### request.query

> **query**: `DocumentNode` = `VOLUNTEER_RANKING`
#### request.variables

> **variables**: `object`
#### request.variables.orgId

> **orgId**: `string` = `'orgId'`
#### request.variables.where

> **where**: `object`
#### request.variables.where.nameContains

> **nameContains**: `string` = `''`
#### request.variables.where.orderBy

> **orderBy**: `string` = `'hours_DESC'`
#### request.variables.where.timeFrame

> **timeFrame**: `string` = `'allTime'`
### result

> **result**: `object`
#### result.data

> **data**: `object`
#### result.data.getVolunteerRanks

> **getVolunteerRanks**: `object`[]
Loading

0 comments on commit da20828

Please sign in to comment.