Skip to content

docs: add GitHub pages deployment troubleshooting guide#7723

Merged
Josh-Cena merged 1 commit into
mainfrom
jc/gh-pages-docs
Jul 4, 2022
Merged

docs: add GitHub pages deployment troubleshooting guide#7723
Josh-Cena merged 1 commit into
mainfrom
jc/gh-pages-docs

Conversation

@Josh-Cena

Copy link
Copy Markdown
Collaborator

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

Deploying to GitHub pages is so popular, yet there are so many pitfalls to avoid. Adding a troubleshooting guide helps save my time as a helper.

Test Plan

Test links

Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/

Related issues/PRs

@Josh-Cena Josh-Cena added the pr: documentation This PR works on the website or other text documents in the repo. label Jul 4, 2022
@Josh-Cena
Josh-Cena requested review from lex111 and slorber as code owners July 4, 2022 14:37
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Jul 4, 2022
@netlify

netlify Bot commented Jul 4, 2022

Copy link
Copy Markdown

[V2]

Name Link
🔨 Latest commit a83c5f2
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/62c2fb36347d800008d0c794
😎 Deploy Preview https://deploy-preview-7723--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions

github-actions Bot commented Jul 4, 2022

Copy link
Copy Markdown

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 70 🟢 100 🟢 100 🟢 100 🟢 90 Report
/docs/installation 🟠 80 🟢 100 🟢 100 🟢 100 🟢 90 Report

@Josh-Cena
Josh-Cena merged commit 426b023 into main Jul 4, 2022
@Josh-Cena
Josh-Cena deleted the jc/gh-pages-docs branch July 4, 2022 14:45
mrizwanashiq pushed a commit to mrizwanashiq/docusaurus that referenced this pull request Jun 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants