Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
153 commits
Select commit Hold shift + click to select a range
96a494d
Initial commit
drasko Feb 13, 2024
332f2c2
Initial add
WashingtonKK Feb 13, 2024
85b5409
Add images and return computation policies
WashingtonKK Feb 14, 2024
7ab4a99
Update mkdocs directory and update index
WashingtonKK Feb 14, 2024
3e8495b
Merge pull request #1 from WashingtonKK/addDocs
drasko Feb 14, 2024
4513004
Add billing docs
WashingtonKK Feb 19, 2024
05a5049
Merge pull request #2 from WashingtonKK/enhanceDocs
drasko Feb 22, 2024
02c6fb0
Add Architecture to navigation
SammyOina Apr 30, 2024
1634204
Refactor code to improve performance and readability
SammyOina May 3, 2024
22990cd
Merge pull request #10 from SammyOina/pd-08
drasko May 3, 2024
5b06680
Expand UI doc and mkdocs with certs and backends
SammyOina May 3, 2024
5291d13
Merge pull request #11 from SammyOina/pd-04
drasko May 3, 2024
fb8f307
Add backend management documentation and resource images
SammyOina May 3, 2024
a9e0f1d
Merge pull request #12 from SammyOina/pd-05
drasko May 7, 2024
6b6039e
Create CNAME
fbugarski May 7, 2024
0e32fa4
Update CNAME
fbugarski May 7, 2024
ae04d35
Change github folder name
fbugarski May 7, 2024
853b69e
Gh pages test
fbugarski May 7, 2024
d126b05
Update prism docs url in README.md
smithjilks May 23, 2024
0344b89
Secure backend and documentation URLs by enabling HTTPS
SammyOina May 24, 2024
81f694d
chore: Update Traefik proxy configuration for UI access
SammyOina May 24, 2024
27ea4d7
Merge pull request #15 from SammyOina/urls
drasko May 24, 2024
794385c
Merge pull request #13 from smithjilks/NOISSUE-update-readme
drasko May 24, 2024
cd399f9
NOISSUE - Use mkdocs recommended structure (#16)
SammyOina May 24, 2024
c74a491
Update computation invitations and policies docs
smithjilks May 26, 2024
5715c42
Update users docs
smithjilks May 26, 2024
326a12a
Update users and domains docs
smithjilks May 27, 2024
e036bed
Update computation policies and invitations docs
smithjilks May 27, 2024
e419f78
Update computation invitations docs
smithjilks May 27, 2024
6add0cc
Merge pull request #14 from smithjilks/prism-docs-6
drasko May 27, 2024
0d4dbb1
Merge pull request #17 from smithjilks/prism-docs-7
drasko May 27, 2024
dd04fb3
NOISSUE - Refactor computation API endpoints and docs (#18)
SammyOina May 27, 2024
48e020c
NOISSUE - Update API paths and reorganize documentation navigation (#19)
SammyOina May 29, 2024
a7f3c3d
remove computation invitations
WashingtonKK Jul 24, 2024
e6c2b58
rename organization to project
WashingtonKK Jul 25, 2024
5a6ea59
replace curl with ui on billing docs
WashingtonKK Jul 25, 2024
4a5d5a7
remove admin functions and fix typo
WashingtonKK Jul 25, 2024
6156518
remove unused images
WashingtonKK Jul 25, 2024
9f07d71
Merge pull request #23 from WashingtonKK/update-docs
drasko Jul 26, 2024
86d81ee
update backend info and images
WashingtonKK Aug 13, 2024
0388dbc
update images
WashingtonKK Aug 13, 2024
8e4e34a
update images
WashingtonKK Aug 13, 2024
e989449
use normal account in screenshots
WashingtonKK Aug 14, 2024
fc7df1a
update admin based images
WashingtonKK Aug 14, 2024
b3603fd
update images
WashingtonKK Aug 14, 2024
a1aa831
return curl commands to docs
WashingtonKK Aug 14, 2024
2692aa4
Merge pull request #28 from WashingtonKK/prism-24
drasko Aug 14, 2024
32b5fe6
update backend info
WashingtonKK Aug 14, 2024
b8b1dda
add links to features
WashingtonKK Aug 14, 2024
a28c827
fix backend description
WashingtonKK Aug 15, 2024
6430ef4
add sample backend info
WashingtonKK Aug 15, 2024
5871a75
NOISSUE - Update Prism logo on docs (#30)
WashingtonKK Aug 15, 2024
5ebc85c
what is prism ai
SammyOina Aug 16, 2024
174ac01
Updated branding to Prism and added new logo
SammyOina May 31, 2024
478e320
Update computation invitations docs
SammyOina Jun 4, 2024
1695222
remove old logo
SammyOina Aug 16, 2024
209f497
replace backend image
SammyOina Aug 16, 2024
2fc6f36
only logo
SammyOina Aug 16, 2024
0aa1bbb
Merge pull request #21 from SammyOina/logo
drasko Aug 16, 2024
d685aca
fix: typos
WashingtonKK Aug 16, 2024
329ecfb
Merge pull request #26 from WashingtonKK/PD-25
drasko Aug 23, 2024
0def7e2
Merge pull request #31 from SammyOina/overview
drasko Aug 23, 2024
ba92b99
Update computation policies docs
smithjilks May 31, 2024
2bd2164
Update computation policies docs
smithjilks May 31, 2024
f0199e9
Update computation policies docs
smithjilks May 31, 2024
b2254ca
Update computation policies docs image refs
smithjilks May 31, 2024
a492c2e
Update policies images
smithjilks Aug 9, 2024
11c847b
Remove old computation policies images
smithjilks Aug 9, 2024
dc017ea
Update policies docs
smithjilks Aug 23, 2024
66631a1
Merge pull request #20 from smithjilks/NOISSUE-update-policies-docs
drasko Aug 23, 2024
781f3cb
chore(ci): Add markdown linter
rodneyosodo Aug 26, 2024
3259913
chore(linter): fix linting errors on markdown files
rodneyosodo Aug 26, 2024
0958709
Merge pull request #33 from rodneyosodo/add-linter
drasko Aug 26, 2024
bd04c16
docs(algorithms): How to run algos using prism
rodneyosodo Aug 26, 2024
d9bc0ef
fix(docs): urls for prism and cocos
rodneyosodo Aug 26, 2024
f6c32f1
fix: enable iframe for youtube
rodneyosodo Aug 26, 2024
5607ee8
docs(algorithm): Add docker example
rodneyosodo Aug 27, 2024
64307e7
Add billing ui steps
smithjilks Jun 4, 2024
5ae5c1d
Remove curl commands
smithjilks Aug 8, 2024
37b432b
Update billing docs images
smithjilks Aug 9, 2024
c5945c3
Remove unused images
smithjilks Aug 9, 2024
129e6b6
Update billing docs
smithjilks Aug 23, 2024
a5df414
Update billing docs
smithjilks Aug 23, 2024
0f621bb
Remove unused billing images
smithjilks Aug 25, 2024
161c7c8
Lint billing docs
smithjilks Aug 28, 2024
8c17ac5
Merge pull request #22 from smithjilks/prism-docs-9
drasko Aug 29, 2024
4b04773
Update docs/algorithms.md
rodneyosodo Aug 30, 2024
c395ae8
Merge pull request #34 from rodneyosodo/algos
drasko Sep 25, 2024
08dc51f
add computation import docs
WashingtonKK Sep 26, 2024
4eed62c
Merge pull request #36 from ultravioletrs/computation-export
drasko Sep 26, 2024
ebb34b8
add ac docs
SammyOina Oct 4, 2024
9723d6a
fix lint
SammyOina Oct 4, 2024
eda18ce
PD-32 - Add stop computation docs (#41)
WashingtonKK Oct 14, 2024
e6a9f22
PD-38 - Add assets docs (#40)
WashingtonKK Oct 14, 2024
7941b9a
Add logs and events docs
smithjilks Oct 29, 2024
974b87e
Merge pull request #42 from smithjilks/PD-39
drasko Oct 29, 2024
5a32ff3
Merge pull request #37 from SammyOina/access-control
drasko Oct 29, 2024
51b3ca1
PD-43 - Remove billing docs (#52)
smithjilks Nov 14, 2024
1bea80f
NOISSUE - Document user keys (#54)
SammyOina Nov 18, 2024
c3ae8f3
PD-44 - Agent config docs (#53)
SammyOina Nov 18, 2024
3a4e299
atls docs
SammyOina Nov 25, 2024
17838d9
fix lint
SammyOina Nov 25, 2024
52f73f8
rename project to workspace
WashingtonKK Nov 27, 2024
935711f
Merge pull request #56 from WashingtonKK/PD-47
drasko Nov 27, 2024
502cb32
Merge pull request #55 from SammyOina/pd-49
drasko Nov 27, 2024
65ed24e
refactor user page
WashingtonKK Nov 28, 2024
f7bc657
update user docs
WashingtonKK Dec 4, 2024
4509c77
remove billing images
WashingtonKK Dec 4, 2024
315bacb
lint
WashingtonKK Dec 4, 2024
52077f3
lint
WashingtonKK Dec 4, 2024
1bcdd75
Add mts/tls docs
smithjilks Nov 28, 2024
69cce63
Update docs
smithjilks Dec 5, 2024
fd078f3
restructure docs
WashingtonKK Dec 5, 2024
56d264e
lint
WashingtonKK Dec 5, 2024
e375086
add image on login
WashingtonKK Dec 5, 2024
e92a2b7
lint
WashingtonKK Dec 5, 2024
24e7645
lint
WashingtonKK Dec 5, 2024
60a4aff
Merge pull request #58 from WashingtonKK/PD-46
drasko Dec 5, 2024
e188296
PD-60-Update getting started doc (#64)
smithjilks Mar 10, 2025
727b0a8
PD-61 - Add cvms docs (#65)
WashingtonKK Mar 10, 2025
4f1340e
NOISSUE - Fix formatting (#63)
jovan-djukic Mar 10, 2025
ce2322e
PD-62 - Remove backends docs (#67)
WashingtonKK Mar 10, 2025
4b3a56a
Merge pull request #57 from smithjilks/PD-51
dborovcanin Mar 11, 2025
8ace32e
PD-71 - Create roles docs (#72)
WashingtonKK Mar 17, 2025
89a8139
PD-62 - Move prism docs to docasaurus (#68)
smithjilks Mar 19, 2025
962bb5e
PD-70 - Add Product page (#73)
SammyOina Apr 3, 2025
b017b06
NOISSUE - Update Node.js version in GitHub Actions (#74)
SammyOina Apr 4, 2025
1c1c251
PD-69 - Update architecture documentation (#77)
SammyOina May 6, 2025
f65e636
Add workspace roles docs (#76)
smithjilks May 7, 2025
0fa4734
docs update
jovan-djukic May 21, 2025
bf90b01
fixed markdownlint error
jovan-djukic May 21, 2025
d20414d
fixed markdownlint error
jovan-djukic May 21, 2025
26c7d4a
Disabled the rule for non-descriptive links
jovan-djukic May 23, 2025
6717247
Merge pull request #79 from ultravioletrs/cvms-docs-update
jovan-djukic Jun 6, 2025
6dfc29c
PD-80 - Test and document mutual attested TLS (#81)
jovan-djukic Jun 9, 2025
54ad7d0
PD-83 - Update documentation to replace Project with Workspace (#87)
SammyOina Jun 18, 2025
c7ea1ac
PD-85 - Update access control docs (#100)
smithjilks Jul 2, 2025
6efa5ec
PD-84 - Update getting started guide: refine CVM creation instruction…
SammyOina Jul 4, 2025
e7368d1
PD-82 - Document billing (#101)
WashingtonKK Jul 17, 2025
327a1e0
PRISM-909 - Separate product info from docs (#103)
smithjilks Jul 21, 2025
84da327
NOISSUE - Enhance architecture documentation (#104)
SammyOina Jul 28, 2025
c24a657
PD-59 - Create API docs (#102)
WashingtonKK Jul 29, 2025
e1f4c36
NOISSUE - Enhance access control documentation: refine role descripti…
SammyOina Aug 6, 2025
6fcc46f
PD-106 - Update images to new UI getting started (#108)
FilipCivljak Aug 7, 2025
8e27877
Update images to new UI workspace (#111)
FilipCivljak Aug 7, 2025
230a9d5
PD-105 - Update billing docs (#112)
WashingtonKK Aug 11, 2025
b36457f
NOISSUE - Improve docs readability
SammyOina Oct 8, 2025
392bb69
NOISSUE- Update computation documentation (#116)
dorcaslitunya Nov 21, 2025
1c4a9f9
NOISSUE - Update billing (#119)
dorcaslitunya Nov 24, 2025
4f65208
PD-118-Add invitations section (#120)
dorcaslitunya Nov 24, 2025
4b21700
NOISSUE - fix sitemap URLs by adding trailingSlash (#122)
FilipCivljak Jan 14, 2026
7a6a632
Merge prism-docs history
SammyOina Feb 10, 2026
7745763
refactor: Restructure documentation, remove unused UI components and …
SammyOina Feb 10, 2026
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
28 changes: 28 additions & 0 deletions .github/workflows/linter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Linter

on:
push:
branches:
- main
pull_request:
branches:
- main

jobs:
ci:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version: latest

- name: Install markdownlint-cli
run: npm install -g markdownlint-cli

- name: run markdownlint
run: markdownlint --disable MD013 MD033 MD007 MD029 MD059 MD024 -- docs
60 changes: 60 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: Publish docs via GitHub Pages

on:
push:
branches:
- main

workflow_dispatch:
permissions:
contents: write

jobs:
build:
name: Build Docusaurus
runs-on: ubuntu-latest

steps:
- name: Checkout main
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: 23
cache: yarn

- name: Install dependencies
run: yarn install --frozen-lockfile

- name: Build the website
run: yarn build

- name: Upload Build Artifact
uses: actions/upload-pages-artifact@v3
with:
path: build


deploy:
name: Deploy to GitHub Pages
needs: build

permissions:
pages: write
id-token: write

environment:
name: github-pages

runs-on: ubuntu-latest

steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
env:
github_token: ${{ secrets.GITHUB_TOKEN }}
CUSTOM_DOMAIN: docs.prism.ultraviolet.rs
1 change: 1 addition & 0 deletions CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs.prism.ultraviolet.rs
6 changes: 6 additions & 0 deletions app/global.css
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
--radius: 0.5rem;
--brand-secondary: 262 83% 58%;
--brand-secondary-foreground: 0 0% 98%;
--fd-layout-width: 1600px;
}

.dark {
Expand All @@ -61,9 +62,14 @@
--ring: 175 70% 50%;
--brand-secondary: 262 83% 64%;
--brand-secondary-foreground: 0 0% 98%;
--fd-layout-width: 1600px;
}
}

@utility container {
margin-inline: auto;
}

#nd-page {
max-width: none;
}
29 changes: 29 additions & 0 deletions content/docs/algorithms.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: "Algorithms"
---

# Algorithms

This demonstrates how to run algorithms using prism.

## Running algorithms

To run algorithms, you need to have a prism installation. You can get it from [here](./getting-started.md). Also you need to have manager running. You can get it from [here](https://docs.cocos.ultraviolet.rs/getting-started/).

Get familiar with running algorithms using cocos [here](https://docs.cocos.ultraviolet.rs/algorithms/), before continuing.

### Python

<iframe width="560" height="315" src="https://www.youtube.com/embed/FoLXuJuUors?si=hWOQq0jbC_cYjA4b" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>

### Binary

<iframe width="560" height="315" src="https://www.youtube.com/embed/IPwU8Qim9Ek?si=QaTNwghIDXFHec_S" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>

### WASM

<iframe width="560" height="315" src="https://www.youtube.com/embed/Lmmnr5lg6bs?si=D9Gb2c_0H7biWW5U" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>

### Docker

<iframe width="560" height="315" src="https://www.youtube.com/embed/IpdkRiQbI0U?si=gQ-2tf3ukUOp6zmc" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
13 changes: 13 additions & 0 deletions content/docs/api-reference/api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: "Prism API"
---

# Prism API

Prism provides a comprehensive API for developers to interact with its features. Below is a detailed reference of the available endpoints, their parameters, and expected responses.

The API is organized into several categories based on functionality. Each endpoint is documented with its method, path, parameters, and a brief description.

:::tip BASE URL
`https://prism.ultraviolet.rs`
:::
211 changes: 211 additions & 0 deletions content/docs/api-reference/assets_api_docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,211 @@
---
title: "Assets"
---

# Assets

:::note Base URL
`https://prism.ultraviolet.rs/computations`
:::

---

## Create Asset

### Endpoint

```http
POST /{domainID}/assets
```

### Body

```json
{
"asset": {
"file_name": "example.csv",
"description": "Training data",
"asset_type": "dataset",
"mime_type": "text/csv",
"asset": "base64-encoded-blob",
"user_key": "base64-encoded-key"
}
}
```

### cURL Example

```bash
curl -X POST "https://prism.ultraviolet.rs/computations/c1adf32-3dac-4aad-bead-ae96fe071239/assets?domainID=c1adf32-3dac-4aad-bead-ae96fe071239" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{ ... }'
```

### Response

```http
201 Created
```

---

## List Assets

### Endpoint

```http
GET /{domainID}/assets
```

### cURL Example

```bash
curl -X GET "https://prism.ultraviolet.rs/computations/c1adf32-3dac-4aad-bead-ae96fe071239/assets?domainID=c1adf32-3dac-4aad-bead-ae96fe071239&limit=10" \
-H "Authorization: Bearer <token>"
```

### Sample Response

```json
{
"assets": [
{
"id": "asset-123",
"file_name": "example.csv",
"description": "Training data",
"asset_type": "dataset",
"mime_type": "text/csv",
"created_at": "2025-07-17T08:00:00Z"
}
],
"limit": 10,
"offset": 0,
"total": 1
}
```

---

## Retrieve Asset

### Endpoint

```http
GET /{domainID}/assets/{id}
```

### cURL Example

```bash
curl -X GET "https://prism.ultraviolet.rs/computations/c1adf32-3dac-4aad-bead-ae96fe071239/assets/asset-123?domainID=c1adf32-3dac-4aad-bead-ae96fe071239" \
-H "Authorization: Bearer <token>"
```

---

## Update Asset

### Endpoint

```http
PUT /{domainID}/assets/{id}
```

### Body

```json
{
"asset": {
"file_name": "example.csv",
"description": "Training data",
"asset_type": "dataset",
"mime_type": "text/csv",
"asset": "base64-encoded-blob",
"user_key": "base64-encoded-key"
}
}
```

### cURL Example

```bash
curl -X PUT "https://prism.ultraviolet.rs/computations/c1adf32-3dac-4aad-bead-ae96fe071239/assets/asset-123?domainID=c1adf32-3dac-4aad-bead-ae96fe071239" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{ ... }'
```

---

## Delete Asset

### Endpoint

```http
DELETE /{domainID}/assets/{id}
```

### cURL Example

```bash
curl -X DELETE "https://prism.ultraviolet.rs/computations/c1adf32-3dac-4aad-bead-ae96fe071239/assets/asset-123?domainID=c1adf32-3dac-4aad-bead-ae96fe071239" \
-H "Authorization: Bearer <token>"
```

### Response

```http
204 No Content
```

---

## Associate Asset to Computation

### Endpoint

```http
POST /{domainID}/assets/{assetID}/{computationID}
```

### cURL Example

```bash
curl -X POST "https://prism.ultraviolet.rs/computations/c1adf32-3dac-4aad-bead-ae96fe071239/assets/asset-123/comp-456?domainID=c1adf32-3dac-4aad-bead-ae96fe071239" \
-H "Authorization: Bearer <token>"
```

---

## Retrieve Asset Computations

### Endpoint

```http
GET /{domainID}/assets/{assetID}/computations
```

### cURL Example

```bash
curl -X GET "https://prism.ultraviolet.rs/computations/c1adf32-3dac-4aad-bead-ae96fe071239/assets/asset-123/computations?domainID=c1adf32-3dac-4aad-bead-ae96fe071239" \
-H "Authorization: Bearer <token>"
```

---

## Unlink Asset from Computation

### Endpoint

```http
PUT /{domainID}/assets/{assetID}/{computationID}
```

### cURL Example

```bash
curl -X PUT "https://prism.ultraviolet.rs/computations/c1adf32-3dac-4aad-bead-ae96fe071239/assets/asset-123/comp-456?domainID=c1adf32-3dac-4aad-bead-ae96fe071239" \
-H "Authorization: Bearer <token>"
```
Loading