add user doc and update topics description (#86)

wri · Nov 9, 2023 · a26278f · a26278f
1 parent fed5dd1
commit a26278f
Show file tree

Hide file tree

Showing 12 changed files with 75 additions and 3 deletions.
diff --git a/deployment/frontend/src/components/dashboard/topics/TopicCard.tsx b/deployment/frontend/src/components/dashboard/topics/TopicCard.tsx
@@ -8,12 +8,15 @@ import { api } from '@/utils/api';
 import Spinner from '@/components/_shared/Spinner';
 import type { SearchInput } from '@/schema/search.schema';
 import Pagination from '../_shared/Pagination';
+import type { GroupTree } from '@/schema/ckan.schema';
 
 
-function TeamProfile({ team }: { team: IRowProfile }) {
-
+function TeamProfile({ team }: { team: GroupTree }) {
+  const description = team?.children?.length ? `${team?.children?.length} subtopics` : 'No subtopics'
+  const teamProfile = team as IRowProfile
+  teamProfile.description = description
   return (
-    <div className='flex py-5 pl-4 sm:pl-8'>
+    <div className='flex py-5 pl-4 sm:pl-8' >
       <RowProfile imgStyle='w-16 h-16 bg-[#F9F9F9] group-hover:bg-white' isPad profile={team} />
     </div>
   )

diff --git a/docs/dashboard/Readme.md b/docs/dashboard/Readme.md
@@ -0,0 +1,69 @@
+## DashBoard
+
+`/dashboard` - to visit dashboard page
+
+
+The left sidebar contains the login user details and accessible list of pages
+
+-user profile-
+
+![](./profile.png)
+
+
+## Dashboard dataset Page `/dashboard/datasets`
+
+Contain tabs of different categories of dataset
+
+![](./datasetpage.png)
+
+
+Each dataset item on hover contains a dropdown button to show it full details
+
+![](./datasetdetails.png)
+
+You can also Search, filter by `teams` and `topics`, also check paginated data
+
+Note: for search, you can click enter key after typing the keyword
+
+## Activity stream `/dashboard/activity-stream`
+
+List all actions , like delete, update and creation of dataset, Teams and topics
+
+![](./activitypage.png)
+
+contains filter by activity type  and pagination
+
+![](./activityfilter.png)
+
+
+## Teams `/dashboard/teams`
+
+Display list of teams the user have access to
+
+- contains search functionality and pagination
+
+- On hover each Team profile , you can see the button `view teams` to go to that team page
+
+![](./teams.png)
+
+on hover
+
+![](./teamhover.png)
+
+## Topics `/dashboard/topics`
+
+Display the list of topics user have access to
+
+Each Topics has a drop down that display list of subtopics
+
+![](./topics.png)
+
+
+## Users `/dashboard/users`
+
+Display list of users
+
+Each user row contains dropdown to display list of teams user belongs to
+
+![](./users.png)
+
diff --git a/docs/dashboard/activity.png b/docs/dashboard/activity.png
diff --git a/docs/dashboard/activityfilter.png b/docs/dashboard/activityfilter.png
diff --git a/docs/dashboard/activitypage.png b/docs/dashboard/activitypage.png
diff --git a/docs/dashboard/datasetdetails.png b/docs/dashboard/datasetdetails.png
diff --git a/docs/dashboard/datasetpage.png b/docs/dashboard/datasetpage.png
diff --git a/docs/dashboard/profile.png b/docs/dashboard/profile.png
diff --git a/docs/dashboard/teamhover.png b/docs/dashboard/teamhover.png
diff --git a/docs/dashboard/teams.png b/docs/dashboard/teams.png
diff --git a/docs/dashboard/topics.png b/docs/dashboard/topics.png
diff --git a/docs/dashboard/users.png b/docs/dashboard/users.png