docs(docs-infra): adds note according to Symlink problem (#24714)
docs: adds note according to Symlink problem Closes #24709 docs(docs-infra): adds section "Developing on Windows" Merge remote-tracking branch 'origin/aioREADME' into aioREADME docs(docs-infra): adds information about admin rights docs(docs-infra): adds hint docs(docs-infra): Change to link PR Close #24714
This commit is contained in:
parent
7b89711402
commit
e60737f63c
|
@ -43,6 +43,17 @@ Here are the most important tasks you might need to use:
|
|||
|
||||
* `yarn build-ie-polyfills` - generates a js file of polyfills that can be loaded in Internet Explorer.
|
||||
|
||||
## Developing on Windows
|
||||
The `packages/` directory may contain Linux-specific symlinks, which are not recognized by Windows.
|
||||
These unresolved links cause the docs generation process to fail because it cannot locate certain files.
|
||||
|
||||
> Hint: The following steps require administration rights or [Windows Developer Mode](https://docs.microsoft.com/en-us/windows/uwp/get-started/enable-your-device-for-development) enabled!
|
||||
|
||||
To fix this problem, run `scripts/windows/create-symlinks.sh`. This command creates temporary files where the symlinks used to be. Make sure not to commit those files with your documentation changes.
|
||||
When you are done making and testing your documentation changes, you can restore the original symlinks and delete the temporary files by running `scripts/windows/remove-symlinks.sh`.
|
||||
|
||||
It's necessary to remove the temporary files, because otherwise they're displayed as local changes in your git working copy and certain operations are blocked.
|
||||
|
||||
## Using ServiceWorker locally
|
||||
|
||||
Since abb36e3cb, running `yarn start --prod` will no longer set up the ServiceWorker, which
|
||||
|
|
Loading…
Reference in New Issue