Skip to content

Update scaffolds and specs for core package architecture #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
oatsandsugar wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update scaffolds and specs for core package architecture #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions apps/registry-docs/app/api/registry/contents/route.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export async function GET() {
const providerBaseUrl =
provider.meta?.registryUrl ??
c.root.meta?.registryUrl ??
`https://github.com/514-labs/factory/tree/main/connector-registry/${c.connectorId}/${version}/${provider.authorId}`;
`https://github.com/514-labs/registry/tree/main/connector-registry/${c.connectorId}/${version}/${provider.authorId}`;

const githubUrl =
impl.implementation === "default"
Expand Down Expand Up @@ -84,7 +84,7 @@ export async function GET() {

const providerBaseUrl =
p.root.meta?.registryUrl ??
`https://github.com/514-labs/factory/tree/main/pipeline-registry/${p.pipelineId}/${version}/${provider.authorId}`;
`https://github.com/514-labs/registry/tree/main/pipeline-registry/${p.pipelineId}/${version}/${provider.authorId}`;

const githubUrl =
impl.implementation === "default"
Expand Down
4 changes: 2 additions & 2 deletions ...-docs/app/connectors/[connector]/[version]/[creator]/[language]/[implementation]/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ export default async function ConnectorImplementationPage({
const registryUrl =
provider.meta?.registryUrl ??
meta?.registryUrl ??
`https://github.com/514-labs/factory/tree/main/connector-registry/${connector}/${version}/${creator}`;
`https://github.com/514-labs/registry/tree/main/connector-registry/${connector}/${version}/${creator}`;

// Get issue URL for current language/implementation
const issueValue = provider.meta?.issues?.[implEntry.language];
Expand All @@ -107,7 +107,7 @@ export default async function ConnectorImplementationPage({
? issueValue
: issueValue && typeof issueValue === "object"
? (issueValue[implEntry.implementation] ?? issueValue["default"])
: `https://github.com/514-labs/factory/issues`;
: `https://github.com/514-labs/registry/issues`;

// Build lists and navigation helpers
const getProviderVersion = (pPath: string): string =>
Expand Down
12 changes: 6 additions & 6 deletions apps/registry-docs/app/docs/connectors/creating/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ export default function CreatingConnectorsPage() {
<h2>1. Clone the repository</h2>
<p>Clone the factory repository to your local machine:</p>
<pre>
<code>{`git clone https://github.com/514-labs/factory.git
cd factory`}</code>
<code>{`git clone https://github.com/514-labs/registry.git
cd registry`}</code>
</pre>

<h2>2. Generate a connector scaffold</h2>
Expand Down Expand Up @@ -180,18 +180,18 @@ pnpm validate:schemas`}</code>
<h2>8. Share your connector</h2>
<p>
Open a pull request to the{" "}
<a href="https://github.com/514-labs/factory" target="_blank">
factory repository
<a href="https://github.com/514-labs/registry" target="_blank">
registry repository
</a>{" "}
to share your connector with the community. Mention the connector{" "}
<a href="https://github.com/514-labs/factory/issues" target="_blank">
<a href="https://github.com/514-labs/registry/issues" target="_blank">
Issue
</a>{" "}
in the PR description.
</p>

<p>
If you built your connector outside the factory monorepo, you'll need to
If you built your connector outside the registry monorepo, you'll need to
add it to the monorepo's registry directory with all required metadata
(defined in `connector-registry/_scaffold`).
</p>
Expand Down
4 changes: 2 additions & 2 deletions apps/registry-docs/app/docs/connectors/quickstart/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ export default function ConnectorQuickstartPage() {

<h2>1. Clone the Repository</h2>
<pre>
<code>{`git clone https://github.com/514-labs/factory.git
cd factory`}</code>
<code>{`git clone https://github.com/514-labs/registry.git
cd registry`}</code>
</pre>

<h2>2. Generate Your Connector</h2>
Expand Down
4 changes: 2 additions & 2 deletions apps/registry-docs/app/docs/pipelines/creating/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ export default function CreatingPipelinesPage() {

<h2>1. Clone the Repository</h2>
<pre>
<code>{`git clone https://github.com/514-labs/factory.git
cd factory`}</code>
<code>{`git clone https://github.com/514-labs/registry.git
cd registry`}</code>
</pre>

<h2>2. Generate Pipeline Scaffold</h2>
Expand Down
2 changes: 1 addition & 1 deletion ...ry-docs/app/pipelines/[pipeline]/[version]/[creator]/[language]/[implementation]/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ export default async function PipelineImplementationPage({
// URLs
const registryUrl =
meta?.registryUrl ??
`https://github.com/514-labs/factory/tree/main/pipeline-registry/${pipeline}/${version}/${creator}`;
`https://github.com/514-labs/registry/tree/main/pipeline-registry/${pipeline}/${version}/${creator}`;

// Build lists and navigation helpers
const getProviderVersion = (pPath: string): string =>
Expand Down
4 changes: 2 additions & 2 deletions apps/registry-docs/app/registry.json/route.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export async function GET() {
const providerBaseUrl =
provider.meta?.registryUrl ??
c.root.meta?.registryUrl ??
`https://github.com/514-labs/factory/tree/main/connector-registry/${c.connectorId}/${version}/${provider.authorId}`;
`https://github.com/514-labs/registry/tree/main/connector-registry/${c.connectorId}/${version}/${provider.authorId}`;

const githubUrl =
impl.implementation === "default"
Expand Down Expand Up @@ -73,7 +73,7 @@ export async function GET() {

const providerBaseUrl =
p.root.meta?.registryUrl ??
`https://github.com/514-labs/factory/tree/main/pipeline-registry/${p.pipelineId}/${version}/${provider.authorId}`;
`https://github.com/514-labs/registry/tree/main/pipeline-registry/${p.pipelineId}/${version}/${provider.authorId}`;

const githubUrl =
impl.implementation === "default"
Expand Down
2 changes: 1 addition & 1 deletion apps/registry-docs/components/site-header.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export async function SiteHeader() {
<ThemeToggle />
<Button asChild variant="ghost" size="sm" className="h-7 px-2">
<Link
href="https://github.com/514-labs/factory"
href="https://github.com/514-labs/registry"
target="_blank"
rel="noopener noreferrer"
aria-label="GitHub repository"
Expand Down
2 changes: 1 addition & 1 deletion apps/registry-docs/content/docs/api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,4 +141,4 @@ These APIs are served as static endpoints and are heavily cached. There are no s

## Support

For issues or questions about the API, please open an issue on the [GitHub repository](https://github.com/514-labs/factory).
For issues or questions about the API, please open an issue on the [GitHub repository](https://github.com/514-labs/registry).
16 changes: 8 additions & 8 deletions apps/registry-docs/content/docs/create.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Follow these steps to create your own connector or pipeline:
Clone the factory repository to your local machine:

```bash
git clone https://github.com/514-labs/factory.git
cd factory
git clone https://github.com/514-labs/registry.git
cd registry
```

<Tabs defaultValue="connector" className="mt-6">
Expand All @@ -24,7 +24,7 @@ cd factory

## 2. Generate a connector scaffold

From the factory directory, run the install script to generate a new connector with the appropriate structure:
From the registry directory, run the install script to generate a new connector with the appropriate structure:

```bash
bash -i <(curl https://registry.514.ai/install.sh) --type connector [connector-name] [version] [author] [language]
Expand Down Expand Up @@ -66,17 +66,17 @@ Your LLM can then help generate the connector implementation following the estab

## 5. Share your connector

Open a pull request to the [factory repository](https://github.com/514-labs/factory) to share your connector with the community. Mention the connector [Issue](https://github.com/514-labs/factory/issues) in the PR description.
Open a pull request to the [registry repository](https://github.com/514-labs/registry) to share your connector with the community. Mention the connector [Issue](https://github.com/514-labs/registry/issues) in the PR description.

If you built your connector outside the factory monorepo, you'll need to add it to the monorepo's registry directory with all required metadata (defined in `connector-registry/_scaffold`).
If you built your connector outside the registry monorepo, you'll need to add it to the monorepo's registry directory with all required metadata (defined in `connector-registry/_scaffold`).

</TabsContent>

<TabsContent value="pipeline">

## 2. Generate a pipeline scaffold

From the factory directory, run the install script to generate a new pipeline with the appropriate structure:
From the registry directory, run the install script to generate a new pipeline with the appropriate structure:

```bash
bash -i <(curl https://registry.514.ai/install.sh) --type pipeline [pipeline-name] [version] [author] [language]
Expand Down Expand Up @@ -112,9 +112,9 @@ Your LLM can then help generate the pipeline implementation following the establ

## 5. Share your pipeline

Open a pull request to the [factory repository](https://github.com/514-labs/factory) to share your pipeline with the community.
Open a pull request to the [registry repository](https://github.com/514-labs/registry) to share your pipeline with the community.

If you built your pipeline outside the factory monorepo, you'll need to add it to the monorepo's registry directory with all required metadata (defined in `pipeline-registry/_scaffold`).
If you built your pipeline outside the registry monorepo, you'll need to add it to the monorepo's registry directory with all required metadata (defined in `pipeline-registry/_scaffold`).

</TabsContent>
</Tabs>
4 changes: 2 additions & 2 deletions apps/registry-docs/content/docs/creating-connectors.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ Follow these steps to create your own connector:
Clone the connector factory repository to your local machine:

```bash
git clone https://github.com/514-labs/factory.git
cd factory
git clone https://github.com/514-labs/registry.git
cd registry
```

## 2. Generate a connector scaffold
Expand Down
2 changes: 1 addition & 1 deletion apps/registry-docs/content/docs/introduction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ on single transactions.

- Consider contributing to the project
- Join [our community](https://join.slack.com/t/moose-community/shared_invite/zt-3bfuso6k7-RldHL6eTpArG3uq4Rz2krQ)
- Leave us a star [on the repo](https://github.com/514-labs/factory)
- Leave us a star [on the repo](https://github.com/514-labs/registry)
- Check out our [blog](https://connectorfactory.dev/blog)
- Follow us on [X](https://x.com/connectorfactory), [LinkedIn](https://www.linkedin.com/company/connector-factory), or [YouTube](https://www.youtube.com/@connectorfactory)

Expand Down
4 changes: 2 additions & 2 deletions apps/registry-docs/content/docs/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ pnpm install

## 1) Clone and install
```bash
git clone https://github.com/514-labs/factory.git
cd factory
git clone https://github.com/514-labs/registry.git
cd registry
pnpm install
```

Expand Down
Loading
Loading