Skip to content

Commit 58839bc

Browse files
authored
Migrate to Docusaurus (#4)
1 parent 26ab65c commit 58839bc

File tree

117 files changed

+28295
-1389
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

117 files changed

+28295
-1389
lines changed

.github/workflows/deploy.yaml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: gh_deploy
2+
on:
3+
push:
4+
branches:
5+
- master
6+
permissions:
7+
contents: write
8+
jobs:
9+
deploy:
10+
environment:
11+
name: github-pages
12+
url: ${{ steps.deployment.outputs.page_url }}
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: Checkout
16+
uses: actions/checkout@v3
17+
# 👇 Build steps
18+
- name: Set up Node.js
19+
uses: actions/setup-node@v3
20+
with:
21+
node-version: 24.x
22+
cache: npm
23+
- name: Install dependencies
24+
run: npm ci
25+
- name: Build
26+
run: npm run build
27+
# 👆 Build steps
28+
- name: Setup Pages
29+
uses: actions/configure-pages@v3
30+
- name: Upload artifact
31+
uses: actions/upload-pages-artifact@v2
32+
with:
33+
# 👇 Build output path
34+
path: build
35+
- name: Deploy to GitHub Pages
36+
id: deployment
37+
uses: actions/deploy-pages@v2

.github/workflows/mkdocs_gh_deploy.yaml

Lines changed: 0 additions & 39 deletions
This file was deleted.

.gitignore

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*
21+
22+
# Shopify
23+
.dev
24+
25+
/docs-backup

constants.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
export const APP_URL = "https://tangleml.com/tangle-ui";
2+
export const GITHUB_REPO_URL = "https://github.com/tangleml/tangle";
3+
export const GITHUB_ISSUES_URL = `${GITHUB_REPO_URL}/issues`;
4+
export const DEMO_URL = "https://tangleml.com/tangle-ui/quick-start";
5+
export const DOCS_URL = "/docs";
6+
7+
export const SLACK_CHANNEL = "#tangle";
8+
export const SUPPORT_EMAIL = "n/a";
9+
export const WEBSITE_URL = "https://tangleml.com/";

docs/assets/logo_white_circle.svg

Lines changed: 0 additions & 168 deletions
This file was deleted.
-346 Bytes
Binary file not shown.
-686 Bytes
Binary file not shown.
-27.1 KB
Binary file not shown.
Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
id: adding-components
3+
title: Adding Components to Pipelines
4+
description: How to add components to your pipeline workspace
5+
---
6+
7+
import { ImageAnnotation } from "@site/src/components/ImageAnnotation";
8+
9+
# Adding Components to Pipelines
10+
11+
Components are the building blocks of your ML pipelines in TangleML. This guide covers the different methods to add components to your pipeline workspace.
12+
13+
14+
### 1. Upload Component File
15+
16+
Upload a YAML component file directly from your computer to add it to your user components library.
17+
18+
:::tip
19+
Uploaded components are immediately available in your User Components library and can be reused across different pipelines.
20+
:::
21+
22+
23+
<ImageAnnotation src={require("./assets/AddingComponents_File.png").default} alt="Import from URL screenshot">
24+
25+
1. Click on the **File** option in the component panel
26+
2. Select a YAML component file from your computer
27+
3. The component will automatically be added to your **User Components** folder
28+
29+
</ImageAnnotation>
30+
31+
32+
### 2. Import from URL
33+
34+
Import components from publicly accessible URLs, particularly useful for GitHub-hosted components.
35+
36+
:::tip
37+
This method works great with raw GitHub URLs, allowing you to import components directly from repositories.
38+
:::
39+
40+
<ImageAnnotation src={require("./assets/AddingComponents_URL.png").default} alt="Import from URL screenshot">
41+
42+
43+
1. Select the **URL** option
44+
2. Enter the publicly accessible URL to the YAML file
45+
3. The browser will automatically download and validate the component
46+
4. If valid, it will be added to your User Components library
47+
48+
</ImageAnnotation>
49+
50+
51+
52+
### 3. In-App Component Editor
53+
54+
Create and edit components directly in your browser using the built-in editor.
55+
56+
:::info
57+
Learn more about the [In-App Component Editor](/docs/component-development/in-app-editor).
58+
:::
59+
60+
<ImageAnnotation src={require("./assets/AddingComponents_New.png").default} alt="In-App Component Editor screenshot">
61+
62+
1. Click on the **New** button in the "Add component" dialog
63+
2. Select the component template you want to use
64+
3. The editor will open and you can start editing the component
65+
4. Once you're done, click the **Save** button to save the component. The component will be added to your User Components library.
66+
67+
</ImageAnnotation>
68+
69+
70+
71+
### 4. Drag and Drop YAML Files
72+
73+
Simply drag a YAML component file from your file system and drop it directly onto the canvas.
74+
75+
<video src={require("./assets/AddingComponents_Drop.mov").default} autoPlay loop muted playsInline style={{ width: "100%" }}>
76+
Your browser does not support the video tag.
77+
</video>
78+
79+
### 5. Import from Other Pipelines
80+
81+
Reuse components from your existing pipelines by importing them into your User Components library.
82+
83+
<video src={require("./assets/AddingComponents_AddFromPipeline.mov").default} autoPlay loop muted playsInline style={{ width: "100%" }}>
84+
Your browser does not support the video tag.
85+
</video>
86+
87+
### 6. Using Standard Library Components
88+
89+
Access components from the Standard Library for tasks shared within the TangleML instance.
90+
91+
:::tip
92+
All components in the Standard Library are well documented with implementation details you can inspect by clicking the component info dialog and checking the **Implementation** tab.
93+
:::
94+
95+
<ImageAnnotation src={require("./assets/AddingComponents_StandardLibrary.png").default} alt="Import from Standard Library screenshot">
96+
97+
1. Expand the **Standard Library** folder in the left panel, Components section.
98+
2. Select the component you want to add.
99+
3. Drag the component onto the canvas.
100+
101+
</ImageAnnotation>
102+
103+
### 7. Shared Components Library
104+
105+
Access components from the Shared Components Library for tasks shared within the TangleML instance.
106+
107+
:::info
108+
Learn more about the [Shared Components Library](/docs/component-development/published-components-library).
109+
:::
Binary file not shown.

0 commit comments

Comments
 (0)