Commit graph

40 commits

Author SHA1 Message Date
Joshua Chen
373eda272e
docs(deployment): add cost-benefit analysis with different options (#6026) 2021-12-02 18:29:13 +01:00
Rey
78537aab2a
docs: update Netlify url config option in deployment instructions (#6019)
Netlify now provides `*.netlify.app` subdomains instead of `*.netlify.com` for project sites. Redirects still work, so the current config option isn't wrong but it's a good idea to keep the docs up to date.
2021-11-27 13:34:32 +08:00
Martin Šošić
b1a4f3913d
docs: improve explanation for url config in GH Pages (#6006) 2021-11-25 16:50:34 +08:00
William Poetra Yoga
f5732e7589
feat: allow GIT_USER env var to be unset if SSH is used (#5840)
* feat: allow GIT_USER env var to be unset if SSH is used

* fix: packages/docusaurus/src/commands/deploy.ts

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>

* feat: allow user to specify deploymentBranch property in docusaurus.config.js (#5841)

* feat: allow user to specify deploymentBranch property in docusaurus.config.js

* docs: remove extra backtick

* docs: fix broken code block

* docs: fix i18n routes to feature requests (#5843)

* docs: fix i18n routes to feature requests

* Add redirect rules

* feat: allow GIT_USER env var to be unset if SSH is used

* fix: packages/docusaurus/src/commands/deploy.ts

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>

* fix: avoid escaping hyphen in regex

* Refactor

* Update deployment.mdx

* Make SSH higher priority

* Only infer but not override

* Add tests

* Fix tests

* Fix

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-11-10 18:51:12 +08:00
Joshua Chen
13d07eff13
docs: refer to deployed branch as deployment rather than target (#5903) 2021-11-08 14:15:28 +08:00
Brennan Kinney
caa9d923a6
docs: add example for Github Pages deployment; rewrite deployment section (#4409)
* docs: Minor copy changes + increment numbered list

* docs: Add alternative github pages deploy workflow

* docs: Add separate PR workflow for alternative gh-pages deploy example

* docs: Minor `gh-pages` deploy config improvements

Improve some comments and clarifies the file path beyond file name alone for each config file.

Additionally removes the workflow path triggers as in practice these being updated shouldn't be triggering a re-run of the workflow again (assuming deterministic build from same input results in same output).

If there is a need for such a manual trigger of the workflow is probably a better approach. Performing a build because workflow comments were modified only would be pointless for example.

* docs: Clarify `gh-pages` deploy config some more

* chore: PR Feedback - Remove inline documentation

Upstream doesn't see value including help comments for a copy/paste config under the basis that it adds friction to the viewer seeking guidance how to perform something they don't know.

* chore: PR Feedback - Rephrase instruction

MatanBobi requested a rephrase during review.

* Rewrite

* Fixes

* Fix!

* Format

* Fix indentation

* Improvements

* Minor fixes

Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
2021-11-07 16:29:08 +08:00
Ivan Boothe
effa46e930
docs: update GitHub deployment instructions (#5888)
* SSH is required for GitHub deployment now

Matches what is listed in the default README.md of a new Docusaurus site

* Minimum node version required is 14.x

documentation.yml as written fails to run because the minimum node version for Docusaurus is 14.x

* Add link to default URL of locally-served site

* Correct deployment workflow

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-11-07 13:29:56 +08:00
William Poetra Yoga
ca9bd244aa
feat: allow user to specify deploymentBranch property in docusaurus.config.js (#5841)
* feat: allow user to specify deploymentBranch property in docusaurus.config.js

* docs: remove extra backtick

* docs: fix broken code block
2021-10-31 12:29:22 +08:00
Sébastien Lorber
fc32194cbb
docs: fix lint issue (#5826) 2021-10-29 16:21:42 +02:00
Gabriel Falcão
b5b2c18118
docs: Update Drone Deployment docs (#5801) 2021-10-29 15:41:12 +02:00
Joshua Chen
d6b4eeb358
feat(theme-classic): make first tab the default tab (#5647)
* Initial work

* Little doc fix

* Doc fix
2021-10-07 17:06:17 +02:00
Joshua Chen
89cb975cc4
docs(website): document npm2yarn plugin + use new Tabs API everywhere (#5590)
* Update docs

* Bad grammar

* Add code highlight
2021-09-22 12:25:21 +02:00
Sébastien Lorber
4f59f0782e
docs: mention Netlify ignore build setting (#5486)
* mention Netlify ignore build setting

* doc backport
2021-09-03 19:34:10 +02:00
Palash Shrivastava
b665b5b859
docs: specify proper min Node.js version in Travis CI example (#5406) 2021-08-23 00:13:53 +03:00
Paul O’Shannessy
8341527fc9
refactor: rename Git master branch to main (#5345)
* Prepare to renaming master branch to main

* Update CONTRIBUTING.md

* Update packages/docusaurus-migrate/src/__tests__/__fixtures__/missing_version_website/website/package.json

* Update packages/docusaurus-migrate/src/__tests__/__fixtures__/complex_website/website/package.json

* Update packages/docusaurus-migrate/src/__tests__/__fixtures__/simple_website/website/package.json

* missing master -> main replaces

* useless char

* For GH Pages org deploy, DEPLOYMENT_BRANCH env is now required

* fix versioning page

* fix vercel links

* update deployment.mdx

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-08-17 18:41:53 +02:00
Arnaud Jeannin
2bd7f0d7a1
docs(v2): Update deploy with Qovery docs for V2 (#5158)
* Update deploy with Qovery docs for V2

Hello Docusaurus team,

I updated the docs for the new Qovery V2

https://www.qovery.com/blog/qovery-v2-beta-is-out

* run prettier on docs

Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-07-14 11:26:42 +02:00
Raz Luvaton
d1f3a3631a
Open docs(v2): Indent code example to improve readability (#5152) 2021-07-13 10:09:19 +02:00
Sébastien Lorber
41eaa690ee
docs(v2): GH pages: recommend using trailingSlash (#5033) 2021-06-22 11:25:34 +02:00
Eshan Tripathi
425eccc5df
docs(v2): typo in deployment.mdx(#5030)
Corrected a minor grammatical error
2021-06-22 10:31:11 +02:00
Tomasz Papiernik
a865eb50b9
docs(v2): Add Buddy to deployment doc (#5027) 2021-06-21 18:15:01 +02:00
Teik Jun
c96c3b5c39
docs(v2): fix incorrect anchor links in website (#5021)
* docs: fix anchor links for docusaurus write-translations

* docs: fix anchor links for docusaurus serve
2021-06-20 22:16:17 +03:00
Sébastien Lorber
df8a900f9c
feat(v2): add trailingSlash config option (#4908)
* POC: add trailingSlash option

* integrate the preferFoldersOutput option of fork @slorber/static-site-generator-webpack-plugin

* Fix broken links when using trailing slash => using md links is more reliable

* fix TS issue

* minor polish

* fix doc page being sensitive to trailing slashes

* Add tests for applyTrailingSlash

* rename test files

* extract and test applyRouteTrailingSlash

* update snapshot

* add trailing slash config to serve command

* fix getSidebar() => still sensitive to trailing slash setting

* never apply trailing slash to an anchor link

* Add documentation for trailingSlash setting
2021-06-09 19:59:39 +02:00
Fardeen Panjwani
62caaeddbb
docs(v2): update steps in the github-actions section (#4876)
* docs: update steps in the github-actions section

* refactor: format warning

* Update website/docs/deployment.mdx

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
2021-06-01 18:05:26 +02:00
Arnaud Jeannin
66254cf0b3
docs(v2): Add Qovery to deployment doc (#4496)
* Support Qovery as a deployment option

* chore: Add .qovery.yml file to deploy app with Qovery 🚀

* refacto: rm backported doc and yaml

* refacto: rm backported docs

* revert file deletion

* prettier

Co-authored-by: Qovery <support@qovery.com>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-04-27 11:06:08 +02:00
Luis Medina Huerta
2f34f9d4bd
docs(v2): Fix urls in deployment.md (#4680)
* docs: update links in deployment.mdx

* fix type in link

* update links to inlineblock

Co-authored-by: luism3861 <eduardo_media@fragua.com.mx>
2021-04-27 10:11:30 +02:00
alena-ko
ad74342a14
docs(v2): Add Hostman to deployment doc (#4668)
* Update deployment.mdx

* prettier + doc fixes

Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-04-26 20:22:47 +02:00
Tales Porto
e99bb43823
feat(v2): docusaurus deploy: ability to configure port in git url (#4545)
* Creating a way to configure the port used on the guthub deploy.

* Fixing some mistakes

Documenting

Adding githubPort documentation on docusaurus.config.js.

Addind SSH protocol prefix. ssh://

Using the default protocol port instead of define it on the code.

Prettify.

* Fixing some mistakes

Documenting

Adding githubPort documentation on docusaurus.config.js.

Addind SSH protocol prefix. ssh://

Using the default protocol port instead of define it on the code.

Prettify.

* Isolating the logic to generate the url and testing it.

* Changing all the names used on tests to something more unserstandable.

* Prettify

Co-authored-by: Tales Porto <t.andrade-porto@klarna.com>
2021-04-09 18:05:16 +02:00
Forresst
51a7988923
docs(v2): fix typo deployment.mdx (#4539) 2021-03-31 15:51:13 +02:00
Alexey Pyltsyn
291a72fbae
docs(v2): use explicit heading IDs (#4460) 2021-03-19 11:00:41 +01:00
Reece Dunham
76c0b11632
refactor(v2): TS config update: reduce the size of npm modules (#4375)
* feat(v2): Reduce the size of the npm modules

Signed-off-by: Reece Dunham <me@rdil.rocks>

* Fix conflicts

* Update search.js

Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-03-17 16:25:42 +01:00
Steve
66e621dca9
docs(v2): add Deploy with QuandCDN (#4430)
* Update deployment.mdx

- Adds QuantCDN deployment target.

* Update deployment.mdx

* Update website/docs/deployment.mdx

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>

* Add QuantCDN docs to showcase.

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-03-16 19:25:12 +01:00
Sébastien Lorber
6811a72e72
feat(v2): ability to "escape" JSX in MDX files as code blocks (#4278)
* Fix MDX Crowdin issues by wrapping complex JSX in code blocks

* Add a remark plugin to unwrap MDX code blocks

* Update MDX Crowdin doc
2021-02-24 12:34:03 +01:00
Matan Borenkraout
967386f4e1
docs(v2): remove npx and use github action to configure ssh key (#4263)
* docs(deployment): remove npx and fix github email

* refactor: use ssh configure action instead of own implementation
2021-02-22 16:21:18 +01:00
Sébastien Lorber
a8ee7fd3e8
docs(v2): i18n doc + polish (#4014)
* add some initial i18n doc

* i18n doc progress

* i18n tutorial progress

* i18n tutorial progress

* polish Crowdin docs

* i18n sidebar in guides

* polish crowdin doc

* update Crowdin doc a bit

* fix annoying relative link to global site resource in template (breaks i18n tutorial)

* template: use simpler export for homepage

* add markdown page example

* rename mdx.md to interactiveDoc.mdx

* update bootstrap/facebook templates too

* sync init template package scripts

* add slug frontmatter doc

* improve i18n doc

* complete i18n doc

* temporarily enable the localeDropdown

* doc typo

* improve the i18n doc

* Add Git i18n doc

* add missing "--" for npm run options (unfortunately they don't get stripped by npm2yarn, and are required foor npm)

* improve a bit the Crowdin doc
2021-01-19 17:26:31 +01:00
Sébastien Lorber
141d062c3b
chore(v2): fix windows Jest tests (#3959)
* test(v2): Fix docusaurus-utils tests for windows

* test(v2): Fix plugin-client-redirects test

- add the posixPath in writeRedirectsFiles.ts

* test(v2): Fix plugin-content-pages test

add posixPath in test and index

* test(v2): add window test configuration

 - add the window test configuration in nodejs-windows.yml

* test(v2): revert plugin-content-pages test fix

* test(v2): Fix mdx-loader/transformImage test

* test(v2): add cleanPath in transformImage test

* fix version path tests for windows

* make versionMetadata test work on Windows

* try to fix posix/win32 path issues

* attempt to fix windows test

* try to make source alias less win32 sensitive

* try to make source alias less win32 sensitive

* try to make source alias less win32 sensitive

* try to make source alias less win32 sensitive

* try to make source alias less win32 sensitive

* try to make source alias less win32 sensitive

* specific jest config for windows

* attempt to fix windows testing issue

* attempt to fix windows testing issue

* attempt to fix windows testing issue

* attempt to fix windows testing issue

* attempt to fix windows testing issue

* attempt to fix windows testing issue

* attempt to fix windows testing issue

* remove bad cleanPath fn

* try to fix windows tests

* try to fix windows tests

* blog: try to fix windows tests by using same logic as on docs plugin

* try to fix windows tests

* try to fix windows tests

* try to fix windows tests

* try to fix windows tests

* improve the Github CI setup for windows: make jobs run in parallel

* revert GH action change

Co-authored-by: Sachin Kumar Rajput <skr571999@gmail.com>
2020-12-28 19:50:12 +01:00
samhrncir
b54ec93c61
docs(v2): Update deployment.mdx (#3950)
Include documentation on environment variable needed for Enterprise GitHub Pages deployment.
2020-12-28 10:35:03 +01:00
Alex1304
1f3f569f3e
docs(v2): wrap section about custom domains in :::info (#3891) 2020-12-07 19:02:01 +01:00
davidmauskop
821a39bf2e
docs(v2): render deployment doc (#3813)
Link to Render's deployment guide
2020-11-30 14:46:27 +01:00
Stephen McElhinney
9309594da9
feat(v2): Added the ability to specify GIT_PASS in deploy command (for CI purposes) (#3694)
* Added the ability to specify GIT_PASS (for CI purposes)

* Fixed variable copy issue

* Added documentation for GIT_PASS

Co-authored-by: Stephen McElhinney <stephen@appstruct.io>
2020-11-09 13:13:10 +01:00
Sébastien Lorber
c22c132fe0
docs(v2): deployment should use mdx extension (#3699)
* deployment: make it a mdx component because it contains <Tabs>

* fix deployment md links

* typo

* fix more links
2020-11-05 18:22:18 +01:00
Renamed from website/docs/deployment.md (Browse further)