Skip to content

Commit

Permalink
Applications docs
Browse files Browse the repository at this point in the history
  • Loading branch information
luccasmmg committed Jan 9, 2025
1 parent a2e7dac commit 3f41113
Show file tree
Hide file tree
Showing 9 changed files with 53 additions and 0 deletions.
42 changes: 42 additions & 0 deletions docs/applications/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# APPLICATIONS

## Create Application

You can create a application in the `/dashboard/applications/new` route where you can define

- Title for the application
- URL for the application, which is going to act as an ID for the application, and act as URL in the public pages such `/applications/{application url}`
- Description for the application
- You can also upload an image to act as a logo or featured image for the application
- A Homepage URL for the application
- A Contact URL for the application
- A Help URL for the application

The page looks like this

![New application page](./create.png)

## Edit Application

You can edit a application by going to `/dashboard/applications/{application url}/edit` or by clicking on the yellow icon in the applications list like in the image below

![All applications page](./list.png)

Once you go there you can change all the fields that were defined in the new application except the `url` which needs to stay the same for the integrity of the system's sake

![Edit application page](./edit.png)

In this edit page, you can also delete by clicking on the "Delete Button" which should open up a modal for confirmation

![Delete application modal](./delete.png)

## Application Discovery

Application discovery `/applications`. contains all available applications

![Applications](./applications.png)

Applications are searchable and paginated. clicking on any of the applications leads to their individual details
page, containing their associated datasets

![Application page](./oneapplication.png)
Binary file added docs/applications/applications.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/applications/create.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/applications/delete.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/applications/edit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/applications/list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/applications/oneapplication.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 11 additions & 0 deletions docs/datasets/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,17 @@ Obs: Fields that have a red * are required

Where the main metadata fields are defined

Here you can define things like

- The title of the dataset
- The name of the dataset, which will be used in the url
- You can attach tags, topics, applications to the dataset
- You can define the team to which that dataset will belong
- Define the visibility
- Technical notes, caution, citation, update frequency and other fields

![overview](./overview.png)

If you select the `featured dataset` checkbox an image uploader will appear where you can define a thumbnail for your dataset

![Featured dataset](./featured_dataset.png)
Expand Down
Binary file modified docs/datasets/overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3f41113

Please sign in to comment.