PaloAltoNetworks / PaloAltoNetworks/docusaurus-openapi-docs

[Bug] Setup of Docusaurus from scratch on Windows

Open
#878 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
TypeScript
Stars
1.1k
Forks
315
Avg merge
7d 5h
Merged PRs (30d)
7

Description

Hello,
I'm trying to set up Docusaurus from scratch on Windows following this instruction - https://github.com/PaloAltoNetworks/docusaurus-openapi-docs?tab=readme-ov-file#bootstrapping-from-template-new-docusaurus-site

But I get an error when cloning the repository.

Here are the steps I follow:

  1. Opening CMD in the Administrator mode.

  2. Running npx create-docusaurus@3.4.0 my-website --package-manager yarn

  • choosing Git repository
  • pasting the URL https://github.com/PaloAltoNetworks/docusaurus-template-openapi-docs.git
  • choosing Copy: do a shallow clone, but do not create a git repo

image

It seems that the directory cannot be created.

Please let me know any solution to that.
Thanks.

EDIT:
I have found an alternative way to set it up on Windows as follows:

git clone --depth 1 https://github.com/PaloAltoNetworks/docusaurus-template-openapi-docs.git my-website
cd my-website
yarn install
yarn start

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the README section on bootstrapping a new Docusaurus site and reproduce the Windows command sequence using create-docusaurus 3.4.0. Compare the failing Git repository setup with the documented direct clone, install, and start commands; done means the README path works on Windows or clearly documents the working alternative.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, react, typescript
Domain
build-system, developer-experience
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.