remove-yarn (#760)
This commit is contained in:
parent
a04c6a7f05
commit
7d0d7013c0
6 changed files with 17 additions and 9970 deletions
8
.github/workflows/deploy-docs-draft.yml
vendored
8
.github/workflows/deploy-docs-draft.yml
vendored
|
|
@ -24,8 +24,8 @@ jobs:
|
|||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 20
|
||||
cache: yarn
|
||||
cache-dependency-path: ./docs/yarn.lock
|
||||
cache: npm
|
||||
cache-dependency-path: ./docs/package-lock.json
|
||||
|
||||
- name: Validate Branch Names
|
||||
run: |
|
||||
|
|
@ -74,14 +74,14 @@ jobs:
|
|||
echo "url=${{ vars.DOCS_DRAFT_BASE_URL }}/langflow-drafts/${{ steps.extract_branch.outputs.draft_directory }}/index.html" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Install dependencies
|
||||
run: cd docs && yarn install
|
||||
run: cd docs && npm install
|
||||
|
||||
- name: Build website
|
||||
if: success()
|
||||
run: |
|
||||
set -o pipefail
|
||||
cd docs
|
||||
yarn build |& tee $GITHUB_WORKSPACE/build.log
|
||||
npm run build |& tee $GITHUB_WORKSPACE/build.log
|
||||
env:
|
||||
BASE_URL: /langflow-drafts/${{ steps.extract_branch.outputs.draft_directory }}
|
||||
FORCE_COLOR: 0 # Disable color output
|
||||
|
|
|
|||
8
.github/workflows/deploy-gh-pages.yml
vendored
8
.github/workflows/deploy-gh-pages.yml
vendored
|
|
@ -17,13 +17,13 @@ jobs:
|
|||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 20
|
||||
cache: yarn
|
||||
cache-dependency-path: ./docs/yarn.lock
|
||||
cache: npm
|
||||
cache-dependency-path: ./docs/package-lock.json
|
||||
|
||||
- name: Install dependencies
|
||||
run: cd docs && yarn install
|
||||
run: cd docs && npm install
|
||||
- name: Build website
|
||||
run: cd docs && yarn build
|
||||
run: cd docs && npm run build
|
||||
# env:
|
||||
# SEGMENT_PUBLIC_WRITE_KEY: ${{ vars.DOCS_PROD_SEGMENT_PUBLIC_WRITE_KEY }}
|
||||
|
||||
|
|
|
|||
|
|
@ -5,13 +5,13 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati
|
|||
## Installation
|
||||
|
||||
```bash
|
||||
yarn
|
||||
npm install
|
||||
```
|
||||
|
||||
## Local Development
|
||||
|
||||
```bash
|
||||
yarn start
|
||||
npm start
|
||||
```
|
||||
|
||||
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
|
||||
|
|
@ -19,7 +19,7 @@ This command starts a local development server and opens up a browser window. Mo
|
|||
## Build
|
||||
|
||||
```bash
|
||||
yarn build
|
||||
npm run build
|
||||
```
|
||||
|
||||
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
||||
|
|
@ -29,13 +29,13 @@ This command generates static content into the `build` directory and can be serv
|
|||
Using SSH:
|
||||
|
||||
```bash
|
||||
USE_SSH=true yarn deploy
|
||||
USE_SSH=true npm run deploy
|
||||
```
|
||||
|
||||
Not using SSH:
|
||||
|
||||
```bash
|
||||
GIT_USER=<Your GitHub username> yarn deploy
|
||||
GIT_USER=<Your GitHub username> npm run deploy
|
||||
```
|
||||
|
||||
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
|
||||
|
|
|
|||
|
|
@ -28,7 +28,6 @@ docs: {
|
|||
See the [Docusaurus docs](https://docusaurus.io/docs/versioning) for more info.
|
||||
|
||||
1. Use the Docusaurus CLI command to create a version.
|
||||
You can use `yarn` instead of `npm`.
|
||||
```bash
|
||||
# Create version 1.0.0 from current docs
|
||||
npm run docusaurus docs:version 1.0.0
|
||||
|
|
|
|||
|
|
@ -96,7 +96,7 @@ Repeated low-quality contributions can lead to a ban on contributions.
|
|||
The OpenRAG documentation is built using [Docusaurus](https://docusaurus.io/) and written in [Markdown](https://docusaurus.io/docs/markdown-features).
|
||||
For style guidance, see the [Google Developer Documentation Style Guide](https://developers.google.com/style).
|
||||
|
||||
1. Install [Node.js](https://nodejs.org/en/download/package-manager) and [Yarn](https://yarnpkg.com/)
|
||||
1. Install [Node.js](https://nodejs.org/en/download/package-manager).
|
||||
|
||||
2. Fork the [OpenRAG GitHub repository](https://github.com/langflow-ai/openrag).
|
||||
|
||||
|
|
@ -123,8 +123,8 @@ For style guidance, see the [Google Developer Documentation Style Guide](https:/
|
|||
5. Install dependencies and start a local Docusaurus static site with hot reload:
|
||||
|
||||
```bash
|
||||
yarn install
|
||||
yarn start
|
||||
npm install
|
||||
npm start
|
||||
```
|
||||
|
||||
The documentation is served at `http://localhost:3000`.
|
||||
|
|
@ -138,7 +138,7 @@ For style guidance, see the [Google Developer Documentation Style Guide](https:/
|
|||
Most pages use a `slug` for shorthand cross-referencing, rather than supplying the full or relative directory path.
|
||||
For example, if a page has a `slug` of `/cool-page`, you can link to it with `[Cool page](/cool-page)` from any other `/docs` page.
|
||||
|
||||
7. Recommended: After making some changes, run `yarn build` to build the site locally with more robust logging.
|
||||
7. Recommended: After making some changes, run `npm run build` to build the site locally with more robust logging.
|
||||
This can help you find broken links before creating a PR.
|
||||
|
||||
8. Create a pull request against the `main` branch of the OpenRAG repository with a clear title and description of your changes:
|
||||
|
|
|
|||
9952
docs/yarn.lock
9952
docs/yarn.lock
File diff suppressed because it is too large
Load diff
Loading…
Add table
Reference in a new issue