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.

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

Fix: Venue details now update without requiring a name change #3302

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
c6b5f16
implement a Visit button in the Joined Organizations filter
gkbishnoi07 Jan 14, 2025
441e842
Resolved: Potential Issue Identified by CodeRabbit AI
gkbishnoi07 Jan 14, 2025
75074ca
Resolved: Potential Issue Identified by CodeRabbit AI
gkbishnoi07 Jan 14, 2025
16b3a25
Resolved: Potential Issue Identified by CodeRabbit AI
gkbishnoi07 Jan 14, 2025
fb0328a
Resolved: Potential Issue Identified by CodeRabbit AI
gkbishnoi07 Jan 15, 2025
06e0030
Update src/components/OrganizationCard/OrganizationCard.tsx
gkbishnoi07 Jan 15, 2025
8320e05
Added test cases
gkbishnoi07 Jan 15, 2025
8947da3
Merge branch 'issue-3162' of https://github.com/gkbishnoi07/talawa-ad…
gkbishnoi07 Jan 15, 2025
91547bd
Added test cases
gkbishnoi07 Jan 15, 2025
3833bb8
added tsdoc
gkbishnoi07 Jan 15, 2025
e711424
resolve: all issue
gkbishnoi07 Jan 15, 2025
9add7b1
Fix: Venue details now update without requiring a name change
gkbishnoi07 Jan 16, 2025
96e3b12
Improve Test Cases
gkbishnoi07 Jan 20, 2025
dc58218
Add Codecov upload step
gkbishnoi07 Jan 20, 2025
d718329
removing changes from pull-request.yml
gkbishnoi07 Jan 20, 2025
7f6bc82
New Tests for Uncovered Lines
gkbishnoi07 Jan 21, 2025
d8bd55a
Added additional test cases
gkbishnoi07 Jan 22, 2025
2992047
Added additional test cases
gkbishnoi07 Jan 22, 2025
4b136aa
added comments in OrganizationCard.spec.tsx
gkbishnoi07 Jan 23, 2025
f2ed680
added test cases
gkbishnoi07 Jan 24, 2025
19cb73c
solved conflict files
gkbishnoi07 Jan 25, 2025
7d8d73f
Update src/components/OrganizationCard/OrganizationCard.tsx
gkbishnoi07 Jan 15, 2025
4eb9678
Added test cases
gkbishnoi07 Jan 15, 2025
c0ecdd0
added tsdoc
gkbishnoi07 Jan 15, 2025
e0ad23a
resolve: all issue
gkbishnoi07 Jan 15, 2025
5c0f6ef
Fix: Venue details now update without requiring a name change
gkbishnoi07 Jan 16, 2025
0df2a88
Improve Test Cases
gkbishnoi07 Jan 20, 2025
87a6ec1
Add Codecov upload step
gkbishnoi07 Jan 20, 2025
daa0bc4
removing changes from pull-request.yml
gkbishnoi07 Jan 20, 2025
c7cae36
New Tests for Uncovered Lines
gkbishnoi07 Jan 21, 2025
0b74a3f
Added additional test cases
gkbishnoi07 Jan 22, 2025
461cdf4
Added additional test cases
gkbishnoi07 Jan 22, 2025
3de58d2
added comments in OrganizationCard.spec.tsx
gkbishnoi07 Jan 23, 2025
0070d72
added test cases
gkbishnoi07 Jan 24, 2025
6b1acc2
solved conflict files
gkbishnoi07 Jan 25, 2025
71ceafd
Resolved Conflict
gkbishnoi07 Jan 25, 2025
072bf8f
Merge branch 'issue-3300' of https://github.com/gkbishnoi07/talawa-ad…
gkbishnoi07 Jan 25, 2025
1955169
Resolved Conflict conflicting file
gkbishnoi07 Jan 25, 2025
bc8bc6f
Resolved Conflict conflicting file
gkbishnoi07 Jan 25, 2025
e424bb0
Resolved Conflict conflicting file
gkbishnoi07 Jan 25, 2025
1844bbf
Resolved Conflict conflicting file
gkbishnoi07 Jan 25, 2025
54b54f8
Resolved Conflict conflicting file
gkbishnoi07 Jan 25, 2025
8ce976f
Resolved Conflict conflicting file
gkbishnoi07 Jan 25, 2025
f01cb90
Resolved issue
gkbishnoi07 Jan 25, 2025
f04913b
Resolved issue
gkbishnoi07 Jan 26, 2025
bfa8878
Resolved issue
gkbishnoi07 Jan 26, 2025
64149b1
Merge upstream/develop-postgres into local develop-postgres
gkbishnoi07 Jan 26, 2025
7268270
Solving Conflict files
gkbishnoi07 Jan 26, 2025
d0826a3
unchanging Sensitive files
gkbishnoi07 Jan 26, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading