smarter-codes / Engineering-Handbook

Engineering handbook in use by Software Engineers at Smarter.Codes. This handbook is contributed by pretty much everyone inside and outside Smarter.Codes. You can edit it too. Just fork and send a pull request
http://deeptech.university:3000/docs/welcome
1 stars 3 forks source link

fixed running instructions #1

Closed abd6982 closed 5 years ago

Tusharsb commented 5 years ago

When i try to execute npm run examples it tries to bring back the boilerplate 'examples' of docusaurus.io. I do not think we want to bring the 'lorem ipsum' documents of docusaurus back into our handbook

or maybe I am missing something ?

$ npm run examples
- docs already exists in handbook. Copying into /home/tushar/projects/handbook/website/../docs-examples-from-docusaurus instead.
- blog already exists in handbook/website.
- .gitignore already exists in handbook.
- Dockerfile already exists in handbook.
- docker-compose.yml already exists in handbook.
- .dockerignore already exists in handbook.
- Footer.js already exists in handbook/website/core/.
- help.js already exists in handbook/website/pages/en/.
- index.js already exists in handbook/website/pages/en/.
- users.js already exists in handbook/website/pages/en/.
- sidebars.json already exists in handbook/website/.
- siteConfig.js already exists in handbook/website/.
- custom.css already exists in handbook/website/static/css/.
- favicon.ico already exists in handbook/website/static/img/.
- oss_logo.png already exists in handbook/website/static/img/.
- undraw_code_review.svg already exists in handbook/website/static/img/.
- undraw_monitor.svg already exists in handbook/website/static/img/.
- undraw_note_list.svg already exists in handbook/website/static/img/.
- undraw_online.svg already exists in handbook/website/static/img/.
- undraw_open_source.svg already exists in handbook/website/static/img/.
- undraw_operating_system.svg already exists in handbook/website/static/img/.
- undraw_react.svg already exists in handbook/website/static/img/.
- undraw_tweetstorm.svg already exists in handbook/website/static/img/.
- undraw_youtube_tutorial.svg already exists in handbook/website/static/img/.
Tusharsb commented 5 years ago

I was able to reproduce your error. When I run npm start the web browser gives me

$ npm start 
Error: You have 'blog' in your headerLinks, but no 'blog' folder exists in your 'website' folder. Did you run `docusaurus-init` or `npm run examples`? If so, make sure you rename 'blog-examples-from-docusaurus' to 'blog'.
    at /home/tushar/experiments/Engineering-Handbook/website/node_modules/docusaurus/lib/core/nav/HeaderNav.js:262:15
    at Array.forEach (<anonymous>)
    at HeaderNav.forEach [as renderResponsiveNav] (/home/tushar/experiments/Engineering-Handbook/website/node_modules/docusaurus/lib/core/nav/HeaderNav.js:250:17)
    at HeaderNav.renderResponsiveNav [as render] (/home/tushar/experiments/Engineering-Handbook/website/node_modules/docusaurus/lib/core/nav/HeaderNav.js:327:19)
    at processChild (/home/tushar/experiments/Engineering-Handbook/website/node_modules/react-dom/cjs/react-dom-server.node.development.js:2959:18)
    at resolve (/home/tushar/experiments/Engineering-Handbook/website/node_modules/react-dom/cjs/react-dom-server.node.development.js:2812:5)
    at ReactDOMServerRenderer.render (/home/tushar/experiments/Engineering-Handbook/website/node_modules/react-dom/cjs/react-dom-server.node.development.js:3202:22)
    at ReactDOMServerRenderer.read (/home/tushar/experiments/Engineering-Handbook/website/node_modules/react-dom/cjs/react-dom-server.node.development.js:3161:29)
    at renderToStaticMarkup (/home/tushar/experiments/Engineering-Handbook/website/node_modules/react-dom/cjs/react-dom-server.node.development.js:3661:27)
    at renderToStaticMarkupWithDoctype (/home/tushar/experiments/Engineering-Handbook/website/node_modules/docusaurus/lib/server/renderUtils.js:16:48)

I think rather than doing npm run examples we should rather remove blog from siteConfig.js file

Tusharsb commented 5 years ago

I think rather than doing npm run examples we should rather remove blog from siteConfig.js file

I have fixed this in a different commit now https://github.com/smarter-codes/Engineering-Handbook/commit/e3bfa9686bdccc64447e228415815306f28c8b7b . Thanks for reporting this issue @abd6982