Add ui documentation

This commit is contained in:
Owen
2025-11-02 14:32:42 -08:00
parent 3c9764fd5a
commit 13437060e2
2 changed files with 11 additions and 1 deletions

BIN
images/create_blueprint.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

View File

@@ -22,7 +22,7 @@ Pangolin supports two blueprint formats:
## YAML Configuration Format ## YAML Configuration Format
YAML config can be applied using the API or from a Newt site. _Application through a CLI tool is planned._ YAML config can be applied using Docker labels, API, from a Newt site, or in the UI. _Application through a CLI tool is planned._
<Card title="Newt YAML"> <Card title="Newt YAML">
@@ -34,6 +34,16 @@ YAML config can be applied using the API or from a Newt site. _Application throu
</Card> </Card>
<Card title="UI YAML">
You can also apply blueprints directly in the Pangolin UI. Navigate to **Settings > Blueprints** and paste your YAML configuration into the provided text area.
<Frame>
<img src="/images/create_blueprint.png" width="400" centered/>
</Frame>
</Card>
<Card title="API YAML"> <Card title="API YAML">
You can also apply blueprints directly through the Pangolin API with an API key. [Take a look at the API documentation for more details.](https://api.pangolin.net/v1/docs/#/Organization/put_org__orgId__blueprint) You can also apply blueprints directly through the Pangolin API with an API key. [Take a look at the API documentation for more details.](https://api.pangolin.net/v1/docs/#/Organization/put_org__orgId__blueprint)