onflow / onflow/flow

Local setup of documentation doesn't work

Open
#794 5 comments 0 reactions 1 assignee View on GitHub

@10thfloor is already working on this.

Since Feb 3, 2022.

bug Feedback
Dominant language
Go
Stars
361
Forks
159
PR merge metrics
No merged PRs in 30d

Description

Problem

I've tried following the guide for the local setup of documentation and it doesn't work. First I tried setting up everything locally on my M1 arm CPU and the error is:

"gatsby-plugin-mdx" threw an error while running the onCreateNode lifecycle:

dlopen(/Users/dapper/Dev/flow/docs/node_modules/oniguruma/build/Release/onig_scanner.node, 0x0001): tried:
'/Users/dapper/Dev/flow/docs/node_modules/oniguruma/build/Release/onig_scanner.node' (mach-o file, but is an incompatible architecture (have 'x86_64', need 'arm64e')),
'/usr/local/lib/onig_scanner.node' (no such file), '/usr/lib/onig_scanner.node' (no such file)



  Error: dlopen(/Users/dapper/Dev/flow/docs/node_modules/oniguruma/build/Release/onig_scanner.node, 0x0001): tried: '/Users/dapper/Dev/flow/docs/node_modules/oniguruma/build/Release/oni
  g_scanner.node' (mach-o file, but is an incompatible architecture (have 'x86_64', need 'arm64e')), '/usr/local/lib/onig_scanner.node' (no such file), '/usr/lib/onig_scanner.node' (no 
  such file)

So obviously it has problems with the ARM (which is concerning on its own since more and more devs will have M1s), but it's also broken for x86, because I went ahead and setup an ubuntu server where I tried to setup the docs so I could deploy changes over git (so much work btw) and it still doesn't work. The error on x86 is:

/var/www/flow/docs/node_modules/yoga-layout-prebuilt/yoga-layout/build/Release/nbind.js:53
        throw ex;
        ^

Error: Channel closed
    at new NodeError (node:internal/errors:371:5)
    at ChildProcess.send (node:internal/child_process:739:16)
    at WorkerPool.doWork (/var/www/flow/docs/node_modules/gatsby-worker/dist/index.js:239:23)
    at WorkerPool.scheduleWork (/var/www/flow/docs/node_modules/gatsby-worker/dist/index.js:254:12)
    at WorkerPool.renderHTML [as scheduleWorkSingle] (/var/www/flow/docs/node_modules/gatsby-worker/dist/index.js:263:17)
    at /var/www/flow/docs/node_modules/gatsby/src/commands/build-html.ts:232:38
    at tryCatcher (/var/www/flow/docs/node_modules/bluebird/js/release/util.js:16:23)
    at MappingPromiseArray._promiseFulfilled (/var/www/flow/docs/node_modules/bluebird/js/release/map.js:68:38)
    at MappingPromiseArray.<anonymous> (/var/www/flow/docs/node_modules/bluebird/js/release/promise_array.js:115:31)
    at MappingPromiseArray.init (/var/www/flow/docs/node_modules/bluebird/js/release/promise_array.js:79:10)
    at MappingPromiseArray._asyncInit (/var/www/flow/docs/node_modules/bluebird/js/release/map.js:37:10)
    at _drainQueueStep (/var/www/flow/docs/node_modules/bluebird/js/release/async.js:97:12)
    at _drainQueue (/var/www/flow/docs/node_modules/bluebird/js/release/async.js:86:9)
    at Async._drainQueues (/var/www/flow/docs/node_modules/bluebird/js/release/async.js:102:5)
    at Immediate.<anonymous> (/var/www/flow/docs/node_modules/bluebird/js/release/async.js:15:14)
    at processImmediate (node:internal/timers:466:21)
Emitted 'error' event on ChildProcess instance at:
    at node:internal/child_process:743:35
Steps to Reproduce

Setup local docs from scratch.

Acceptance Criteria

It should work and be simple.

Context

Today I've spent hours on getting the docs to work and I should spend them making the docs. I really feel this process needs to be polished and improved, else docs will just keep getting worse.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.