P5.js: createFile Input reference example not rendering

Created on 10 Jan 2019  路  9Comments  路  Source: processing/p5.js

Nature of issue?

  • [x] Found a bug
  • [ ] Existing feature enhancement
  • [ ] New feature request

Most appropriate sub-area of p5.js?

  • [x ] Documentation

Details about the bug:

The reference example for createFileInput is not rendering correctly.

All 9 comments

I would like to work on this issue!

@Ajayneethikannan Do go ahead! It is missing HTML tags so it isn't rendering correctly.

@limzykenneth I checked the example present in the inline documentation of the createFileInput method,
and it contains the proper HTML tags.

I checked the commit history of p5.dom.js and the tags were fixed a long time ago (https://github.com/processing/p5.js/commit/3f99a89ad714cb9483f7354179e167d5392c5761#diff-84dfcaf5d56a24f4ee13a32c644817b0)

But I found that the data.json and data.min.json file in p5.js-website/src/templates/pages/reference
do not contain the 'code' and 'div' tags, and changing them, properly renders the examples in the p5.js-website

Should I just change those two files and make a pull request (in p5.js-website repository) ?
Please, can you explain how the inline examples(stored in this repository) are converted into documentation(in p5.js-website) for the reference ?

@Ajayneethikannan Actually on further investigation this is a different problem linked to the website itself. You can checkout the developer docs for more information about how things are built.

@lmccart The data.min.json version has reverted back to 0.6.1, I thought we managed to fixed that already? Will look into this further especially with the new travis build stuff.

@lmccart I see that there hasn't been a release since we fixed the docs release step so I assume the release tasks were not run between then and now so we are stuck with a pre-fixed version of data.json file. Can you run grunt release-docs on your side to just update the docs, we can at the same time test if it trigger a website rebuild with travis as well.

@limzykenneth I tried running this and got this error:

(node:99289) UnhandledPromiseRejectionWarning: Error: Error: Command failed: rm -rf p5-website/ && git clone -q https://github.com/undefined/p5.js-website.git p5-website
remote: Repository not found.
fatal: repository 'https://github.com/undefined/p5.js-website.git/' not found

    at /Users/lmccart/Documents/p5/p5.js/tasks/release/release-docs.js:82:17
    at process.internalTickCallback (internal/process/next_tick.js:77:7)
(node:99289) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). (rejection id: 1)
(node:99289) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

I'm guessing I'm missing a login or token setting. Is this grunt release-docs command in the docs somewhere where I can see if there are further instructions?

it looks like release-docs can't be run directly. you would need to run release-p5 in order to initialize the configuration correctly, however that's going to push a whole new release out. maybe try commenting out all but step 4 in release-p5.js ?

@lmccart You can replace this line with var releaseParty = "processing"; because as @Spongman mentions the configuration is set at release-p5 but what I usually do when testing is to either comment out the pushing to github part or replace the above to my github handle. I think everything else should just work.

It probably isn't documented on its own because it is meant to run with other release steps as part of release-p5.

ok, looks like we're good now. I ran the command as you instructed and docs updated to 0.7.2, which is the latest. I agree this doesn't need to be documented publicly.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

tigoe picture tigoe  路  29Comments

workergnome picture workergnome  路  32Comments

ofZach picture ofZach  路  29Comments

ScottGrogin picture ScottGrogin  路  36Comments

lmccart picture lmccart  路  49Comments