Skip to content

Commit d6a9fa1

Browse files
Removing docs-v2 from the repo (#18183)
* removing docs-v2 * Removing additional docs-v2 refs (build commands and gh action) * Update pnpm-lock.yaml
1 parent 2afb3e4 commit d6a9fa1

File tree

622 files changed

+4
-55793
lines changed

Some content is hidden

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

622 files changed

+4
-55793
lines changed

.github/workflows/docs-pr.yaml

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

docs-v2/.env.example

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

docs-v2/.gitignore

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

docs-v2/.npmrc

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

docs-v2/.tool-versions

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

docs-v2/LICENSE

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

docs-v2/README.md

Lines changed: 3 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,5 @@
11
# Pipedream docs
22

3-
> [!WARNING]
4-
> **⚠️ THIS PROJECT IS DEPRECATED ⚠️**
5-
>
6-
> This docs-v2 directory is no longer maintained. Do not make changes to files in this directory as they will not be deployed or used.
7-
>
8-
> The documentation has been moved to a new location. Please contact the team for the current documentation repository.
9-
10-
## Quickstart
11-
12-
[Install `asdf`](https://asdf-vm.com/guide/getting-started.html) if you haven't already.
13-
14-
```bash
15-
asdf install
16-
pnpm dev
17-
```
18-
19-
Open [http://localhost:3000/docs](http://localhost:3000/docs).
20-
21-
We use [Nextra](https://nextra.site/docs), [a Next.js app](https://nextjs.org/docs). Nextra builds docs from the `pages/` directory. All docs are [MDX](https://mdxjs.com/) files (Markdown with React components / JSX).
22-
23-
Run `yarn build` before pushing to your branch to confirm everything builds OK.
24-
25-
## VuePress -> Nextra
26-
27-
We're moving from VuePress to Nextra. Here's what's the same and what's different:
28-
29-
- New docs are here, in the `docs-v2/` directory.
30-
- All docs are still Markdown. Now MDX files instead of just Markdown, so extensions have been renamed to `.mdx`.
31-
- Keep images in `public/images/foo.png`, reference with `![alt text](/images/foo.png)`
32-
- Leaf nodes in VuePress were at files like `/docs/workflows/workspaces/sso/google/README.md`. Nextra allows leaf nodes to be non-index files like `/docs/workflows/workspaces/sso/google.mdx`, so there's no need for the final directory, which simplifies things.
33-
- VuePress used Vue, Nextra uses React. All of the custom components used in MDX files are either [built-in Nextra components](https://nextra.site/docs/guide/built-ins) or Pipedream-specific components in `components/`, ported from Vue.
34-
- Learn the [built-in Nextra components](https://nextra.site/docs/guide/built-ins). All the `::: tip`, `::: warning`, or other special VuePress components have an equivalent Nextra component.
35-
36-
## Nextra
37-
38-
We use the [Nextra Docs Theme](https://nextra.site/docs/docs-theme/start), which adds functionality on the base Nextra app. Most of the features we use are well-documented there.
39-
40-
The [Nextra docs](https://nextra.site/docs) and [GitHub](https://github.com/shuding/nextra) are great. Anything not specific to Nextra is likely a feature of [Next.js](https://nextjs.org/docs) or [MDX](https://mdxjs.com/), also well-maintained and modern projects as of 2024.
41-
42-
Check `theme.config.tsx` for the latest config.
43-
44-
### Useful Nextra components
45-
46-
We use almost all of [the Nextra built-in components](https://nextra.site/docs/guide/built-ins) in docs.
47-
48-
### Adding new pages / routes
49-
50-
Nextra and Next.js tie routing closer to the directory structure of the app:
51-
52-
```
53-
pages
54-
index.mdx # /docs
55-
data-stores.mdx # /docs/data-stores
56-
http.mdx # /docs/http
57-
workspaces/
58-
index.mdx # /docs/workspaces
59-
sso/
60-
index.mdx # /docs/workflows/workspaces/sso
61-
google.mdx # /docs/workflows/workspaces/sso/google
62-
```
63-
64-
The `_meta.tsx` files in each directory defines a mapping between the labels in the sidebar and the files in that directory. If you want to add an item to the sidebar, you'll probably want to edit the `_meta.tsx` file. [See the Nextra docs](https://nextra.site/docs/docs-theme/page-configuration) for more info.
65-
66-
## Custom components
67-
68-
Use (and create!) custom components in `components/`. You'll see a lot of references to these components in the MDX.
69-
70-
## Redirects
71-
72-
If you need to add any custom redirects, e.g. when you move pages to a different directory, add then to the `vercel.json` file in this directory.
73-
74-
## Adding new versions
75-
76-
Add a new version of docs by creating a new feature branch in the format of `docs-v{number}-pathing`.
3+
> [!WARNING] > **⚠️ THIS PROJECT IS DEPRECATED ⚠️**
4+
>
5+
> Pipedream public docs have moved to a new repo. Please contact the team for the current documentation repository.

docs-v2/components/AccountConnectionDemo.jsx

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

0 commit comments

Comments
 (0)