Skip to content

Commit

Permalink
Merge pull request #11 from zhiva-ai/staging
Browse files Browse the repository at this point in the history
Domain change to org
  • Loading branch information
burnpiro authored Nov 23, 2023
2 parents e56890d + 8193202 commit 25f3d5c
Show file tree
Hide file tree
Showing 21 changed files with 47 additions and 47 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:
action: "upload"
###### Repository/Build Configurations - These values can be configured to match your app requirements. ######
# For more information regarding Static Web App workflow configurations, please visit: https://aka.ms/swaworkflowconfig
app_build_command: "npm run build && npm run set-domain -- staging.docs.zhiva.ai"
app_build_command: "npm run build && npm run set-domain -- staging.docs.zhiva.org"
app_location: "/" # App source code path
api_location: "" # Api source code path - optional
output_location: "public" # Built app content directory - optional
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# zhiva.ai Docs
# ZhivaAI Docs

### Versions:
- [Production documentation](https://docs.zhiva.ai/latest)
- [Staging documentation](https://docs-staging.zhiva.ai/latest)
- [Production documentation](https://docs.zhiva.org/latest)
- [Staging documentation](https://docs-staging.zhiva.org/latest)

## Working on your OpenAPI Definition

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ As you can see, this server is not on the list and is not a valid server yet. Yo
- __Supports Fuzzy Matching__ - Does server supports _Fuzzy Matching_ when searching for Studies? ([Our Local Server](/latest/setting-up-local-pacs) does)
- __Can Store/Update Data?__ - Check if user has access to modify data on PACS (more about it in [Local PACS Security](/latest/local-pacs-security/) section)

### zhiva.ai Local Server Setup
### ZhivaAI Local Server Setup

We've created predefined server settings for [Our Local Server](/latest/setting-up-local-pacs). It is available under `Local Server` option. You might want to modify the `Server URL` to accommodate your local network settings. If you running the server on your local machine then leave `localhost` as hostname. If the server is somewhere in your network then change `localhost` to servers' IP address (sth. like `192.168.x.x`).

Expand Down
2 changes: 1 addition & 1 deletion content/pages/v0.1/local-pacs/local-pacs.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ git clone https://github.com/zhiva-ai/pacs-server.git
```

or download it directly from
[zhiva.ai PACS server](https://github.com/zhiva-ai/pacs-server/archive/refs/heads/main.zip).
[ZhivaAI PACS server](https://github.com/zhiva-ai/pacs-server/archive/refs/heads/main.zip).

## Generate local TSL certificate

Expand Down
2 changes: 1 addition & 1 deletion content/pages/v0.1/model-api/model-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ You can either clone this repo
git clone https://github.com/zhiva-ai/Lung-Segmentation-API.git
```
or download it directly from
[zhiva.ai Local Model API](https://github.com/zhiva-ai/Lung-Segmentation-API/archive/refs/heads/main.zip).
[ZhivaAI Local Model API](https://github.com/zhiva-ai/Lung-Segmentation-API/archive/refs/heads/main.zip).

## Build the server

Expand Down
2 changes: 1 addition & 1 deletion content/pages/v0.1/model-proxy/model-proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ git clone https://github.com/zhiva-ai/model-proxy-example.git
```

or download it directly from
[zhiva.ai PACS server](https://github.com/zhiva-ai/model-proxy-example/archive/refs/heads/main.zip).
[ZhivaAI PACS server](https://github.com/zhiva-ai/model-proxy-example/archive/refs/heads/main.zip).

## Local PACS and Model API

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Both methods should automatically set up your PACS and redirect you to list of y
You can also use your custom token server to setup PACS configuration. Just generate link:

```javascript
https://alpha.zhiva.ai/auth/oauth?token=YOUR_AUTH_TOKEN
https://alpha.zhiva.org/auth/oauth?token=YOUR_AUTH_TOKEN
```

Where `YOUR_AUTH_TOKEN` is the same token as in [Token auth](/managing-servers-inside-the-dicom-viewer/#token-auth);
Expand Down Expand Up @@ -64,7 +64,7 @@ As you can see, this server is not on the list and is not a valid server yet. Yo
- __Supports Fuzzy Matching__ - Does server supports _Fuzzy Matching_ when searching for Studies? ([Our Local Server](/latest/setting-up-local-pacs) does)
- __Can Store/Update Data?__ - Check if user has access to modify data on PACS (more about it in [Local PACS Security](/latest/local-pacs-security/) section)

### zhiva.ai Local Server Setup
### ZhivaAI Local Server Setup

We've created predefined server settings for [Our Local Server](/latest/setting-up-local-pacs). It is available under `Local Server` option. You might want to modify the `Server URL` to accommodate your local network settings. If you running the server on your local machine then leave `localhost` as hostname. If the server is somewhere in your network then change `localhost` to servers' IP address (sth. like `192.168.x.x`).

Expand Down
6 changes: 3 additions & 3 deletions content/pages/v0.3/local-pacs-with-token/local-pacs.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ git clone https://github.com/zhiva-ai/pacs-token-server.git
```

or download it directly from
[zhiva.ai JWT PACS server](https://github.com/zhiva-ai/pacs-token-server/archive/refs/heads/main.zip).
[ZhivaAI JWT PACS server](https://github.com/zhiva-ai/pacs-token-server/archive/refs/heads/main.zip).

## Generate local TSL certificate

Expand Down Expand Up @@ -150,10 +150,10 @@ At the end you'll be presented with one-off __AuthToken__.
__Auth Token__ is used to sign-in user in zhiva application. You can use it in [Zhiva login](/latest/managing-servers-inside-the-dicom-viewer/#zhiva-login), or you can generate __one-off login URL__:

```javascript
https://alpha.zhiva.ai/auth/oauth?token=YOUR_AUTH_TOKEN
https://alpha.zhiva.org/auth/oauth?token=YOUR_AUTH_TOKEN
```

This link can bo modified if you're using different domain/subdomain than default `alpha.zhiva.ai`. Just replace the domain and leave the rest of the path the same. Link for the default domain is also stored in __This Direct Link__ just below textfield with token.
This link can bo modified if you're using different domain/subdomain than default `alpha.zhiva.org`. Just replace the domain and leave the rest of the path the same. Link for the default domain is also stored in __This Direct Link__ just below textfield with token.

### Access to orthanc explorer

Expand Down
2 changes: 1 addition & 1 deletion content/pages/v0.3/model-proxy/model-proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ git clone https://github.com/zhiva-ai/model-proxy-example.git
```

or download it directly from
[zhiva.ai PACS server](https://github.com/zhiva-ai/model-proxy-example/archive/refs/heads/main.zip).
[ZhivaAI PACS server](https://github.com/zhiva-ai/model-proxy-example/archive/refs/heads/main.zip).

## Local PACS and Model API

Expand Down
6 changes: 3 additions & 3 deletions gatsby-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ module.exports = {
{
resolve: "gatsby-plugin-manifest",
options: {
name: `zhiva.ai Documentation`,
short_name: `Docs | zhiva.ai`,
description: `Documentation for zhiva.ai`,
name: `ZhivaAI Documentation`,
short_name: `Docs | ZhivaAI`,
description: `Documentation for ZhivaAI`,
lang: `en`,
icon: "src/images/icon.png",
},
Expand Down
2 changes: 1 addition & 1 deletion openapi/info-description-v0.1.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
This is a documentation for _zhiva.ai_ products. Feel free to read the whole thing but here is a:
This is a documentation for _ZhivaAI_ products. Feel free to read the whole thing but here is a:

# Quickstart

Expand Down
2 changes: 1 addition & 1 deletion openapi/info-description-v0.2.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
This is a documentation for _zhiva.ai_ products. Feel free to read the whole thing but here is a:
This is a documentation for _ZhivaAI_ products. Feel free to read the whole thing but here is a:

# Quickstart

Expand Down
2 changes: 1 addition & 1 deletion openapi/info-description-v0.3.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
This is a documentation for _zhiva.ai_ products. Feel free to read the whole thing but here is a:
This is a documentation for _ZhivaAI_ products. Feel free to read the whole thing but here is a:

# Quickstart

Expand Down
10 changes: 5 additions & 5 deletions openapi/v0.1.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
openapi: 3.1.0
info:
version: 0.1.1
title: zviha.ai
termsOfService: 'https://zhiva.ai/terms/'
title: ZhivaAI
termsOfService: 'https://zhiva.org/terms/'
contact:
email: ceo@zhiva.ai
url: 'https://zhiva.ai'
email: ceo@zhiva.org
url: 'https://zhiva.org'
description:
$ref: ./info-description-v0.1.md
tags:
Expand All @@ -26,7 +26,7 @@ x-tagGroups:
section: inferences
tags: []
servers:
- url: 'https://api.zhiva.ai/v1'
- url: 'https://api.zhiva.org/v1'
paths:
'/segmentations/{model-uid}/studies/{study-uid}':
$ref: 'v0.1/paths/segmentations/segmentations@{model-uid}@{study-uid}.yaml'
Expand Down
10 changes: 5 additions & 5 deletions openapi/v0.2.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
openapi: 3.1.0
info:
version: 0.2.2
title: zviha.ai
termsOfService: 'https://zhiva.ai/terms/'
title: ZhivaAI
termsOfService: 'https://zhiva.org/terms/'
contact:
email: ceo@zhiva.ai
url: 'https://zhiva.ai'
email: ceo@zhiva.org
url: 'https://zhiva.org'
description:
$ref: ./info-description-v0.2.md
tags:
Expand All @@ -26,7 +26,7 @@ x-tagGroups:
section: inferences
tags: []
servers:
- url: 'https://api.zhiva.ai/v1'
- url: 'https://api.zhiva.org/v1'
paths:
'/segmentations/{model-uid}/studies/{study-uid}':
$ref: 'v0.2/paths/segmentations/segmentations@{model-uid}@{study-uid}.yaml'
Expand Down
10 changes: 5 additions & 5 deletions openapi/v0.3.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
openapi: 3.1.0
info:
version: 0.3.1
title: zviha.ai
termsOfService: 'https://zhiva.ai/terms/'
title: ZhivaAI
termsOfService: 'https://zhiva.org/terms/'
contact:
email: ceo@zhiva.ai
url: 'https://zhiva.ai'
email: ceo@zhiva.org
url: 'https://zhiva.org'
description:
$ref: ./info-description-v0.3.md
tags:
Expand All @@ -26,7 +26,7 @@ x-tagGroups:
section: inferences
tags: []
servers:
- url: 'https://api.zhiva.ai/v1'
- url: 'https://api.zhiva.org/v1'
paths:
'/segmentations/{model-uid}/studies/{study-uid}':
$ref: 'v0.3/paths/segmentations/segmentations@{model-uid}@{study-uid}.yaml'
Expand Down
8 changes: 4 additions & 4 deletions openapi/v1.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
openapi: 3.1.0
info:
version: 0.1.0
title: zviha.ai
termsOfService: 'https://zhiva.ai/terms/'
title: ZhivaAI
termsOfService: 'https://zhiva.org/terms/'
contact:
email: ceo@zhiva.ai
url: 'https://zhiva.ai/contact'
email: ceo@zhiva.org
url: 'https://zhiva.org/contact'
description:
$ref: ./info-description.md
tags:
Expand Down
6 changes: 3 additions & 3 deletions siteConfig.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
module.exports = {
title: "zhiva.ai",
siteUrl: "https://docs.zhiva.ai",
description: "Documentation for zhiva.ai",
title: "ZhivaAI",
siteUrl: "https://docs.zhiva.org",
description: "Documentation for ZhivaAI",
sections: [
{
name: "Guides",
Expand Down
4 changes: 2 additions & 2 deletions src/components/Layout/Header.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ export default function Header({
<Grid item xs />
<Grid item>
<Link
href="https://zhiva.ai"
href="https://zhiva.org"
variant="body2"
sx={{
textDecoration: "none",
Expand All @@ -78,7 +78,7 @@ export default function Header({
rel="noopener noreferrer"
target="_blank"
>
Go to <strong>zhiva.ai</strong> homepage
Go to <strong>ZhivaAI</strong> homepage
</Link>
</Grid>
</Grid>
Expand Down
4 changes: 2 additions & 2 deletions src/components/Layout/Layout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ function Copyright() {
return (
<Typography variant="body2" color="text.secondary" align="center">
{"Copyright © "}
<Link color="inherit" href="https://zhiva.ai/">
zhiva.ai
<Link color="inherit" href="https://zhiva.org/">
zhiva.org
</Link>{" "}
{new Date().getFullYear()}.
</Typography>
Expand Down
2 changes: 1 addition & 1 deletion static/CNAME
Original file line number Diff line number Diff line change
@@ -1 +1 @@
docs.zhiva.ai
docs.zhiva.org

0 comments on commit 25f3d5c

Please sign in to comment.