Skip to content

Commit

Permalink
Newest documentation version and some improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
MagalhaesD77 committed Sep 12, 2024
1 parent cabb08f commit b12aad1
Show file tree
Hide file tree
Showing 28 changed files with 209 additions and 996 deletions.
41 changes: 16 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,40 +2,31 @@

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

### Installation
## Requirements

```
$ yarn
```

### Local Development

```
$ yarn start
```
- Node.js version 18.0 or above (which can be checked by running `node -v`). You can use [nvm](https://github.com/nvm-sh/nvm) for managing multiple Node versions on a single machine installed.
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
For more information, please refer to the [official documentation](https://docusaurus.io/docs/installation).

### Build
## Install the dependencies

```
$ yarn build
```bash
npm install
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment
### Run Local Development

Using SSH:

```
$ USE_SSH=true yarn deploy
```bash
npm start
```

Not using SSH:
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

```
$ GIT_USER=<Your GitHub username> yarn deploy
## Build for Production

```bash
npm build
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
This command generates static content into the `build` directory and can be served using any static contents hosting service.
4 changes: 4 additions & 0 deletions docs/api_related.md → docs/api_docs.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
sidebar_position: 5
---

# API Docs

#### Discover the functionalities offered by our platform through our API documentation:
Expand Down
39 changes: 39 additions & 0 deletions docs/api_requests_flow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
sidebar_position: 3
---

# API Request Flows

## App Package

### POST

![New App Package](./images/new_app_pkg.png)

### GET (List)

![List App Packages](./images/list_app_pkgs.png)

## App Package/{app_pkg_id}

### GET (Individual Package)

![Get App Package](./images/get_app_pkg.png)

### PUT

![Update App Package](./images/update_app_pkg.png)

### DELETE

![Delete App Package](./images/delete_app_pkg.png)

## App Package/{app_pkg_id}/instantiate

### Instantiate

![Instantiate App Package](./images/instantiate_app_pkg.png)

### Terminate

![Terminate App Package](./images/terminate_app_pkg.png)
Loading

0 comments on commit b12aad1

Please sign in to comment.