Compare commits

...

7 Commits

Author SHA1 Message Date
Germán Jabloñski
b7fea7a7ab change folder names 2024-12-10 12:18:03 -03:00
Germán Jabloñski
e5564a18e6 change folder names 2024-12-10 12:14:52 -03:00
Germán Jabloñski
d0f1cda6e4 Merge remote-tracking branch 'origin/main' into v2-docs-excluded 2024-12-10 12:13:34 -03:00
Germán Jabloñski
033e528ee6 improve contributing.md 2024-12-10 10:53:51 -03:00
Germán Jabloñski
2a038a4664 change yarn with pnpm in contributing to docs 2024-12-10 08:56:33 -03:00
Germán Jabloñski
b32a070c70 Merge remote-tracking branch 'origin/main' into v2_docs 2024-12-10 08:51:53 -03:00
Germán Jabloñski
54a56f8bf0 add v2 docs to main branch 2024-12-10 08:50:37 -03:00
218 changed files with 16476 additions and 5 deletions

View File

@@ -52,5 +52,8 @@
"jestrunner.jestCommand": "pnpm exec cross-env NODE_OPTIONS=\"--no-deprecation\" node 'node_modules/jest/bin/jest.js'",
"jestrunner.debugOptions": {
"runtimeArgs": ["--no-deprecation"]
},
"search.exclude": {
"**/docs/V2_(excluded_from_search)/**": true
}
}

View File

@@ -116,12 +116,12 @@ For all Pull Requests, you should be extremely descriptive about both your probl
This is how you can preview changes you made locally to the docs:
1. Clone our [website repository](https://github.com/payloadcms/website)
2. Run `yarn install`
3. Duplicate the `.env.example` file and rename it to `.env`
1. Clone our [website repository](https://github.com/payloadcms/website) `git clone https://github.com/payloadcms/website.git && cd website`
2. Run `pnpm install`
3. Duplicate the `.env.example` file and rename it to `.env` (`cp .env.example .env`)
4. Add a `DOCS_DIR` environment variable to the `.env` file which points to the absolute path of your modified docs folder. For example `DOCS_DIR=/Users/yourname/Documents/GitHub/payload/docs`
5. Run `yarn run fetchDocs:local`. If this was successful, you should see no error messages and the following output: _Docs successfully written to /.../website/src/app/docs.json_. There could be error messages if you have incorrect markdown in your local docs folder. In this case, it will tell you how you can fix it
6. You're done! Now you can start the website locally using `yarn run dev` and preview the docs under [http://localhost:3000/docs/](http://localhost:3000/docs/)
5. Run `pnpm run fetchDocs:local`. If this was successful, you should see no error messages and the following output: _Docs successfully written to /.../website/src/app/docs.json_. There could be error messages if you have incorrect markdown in your local docs folder. In this case, it will tell you how you can fix it
6. You're done! Now you can start the website locally using `pnpm run dev` and preview the docs under [http://localhost:3000/docs/](http://localhost:3000/docs/)
## Internationalization (i18n)

Some files were not shown because too many files have changed in this diff Show More