search

orbitdb / field-manual

The Offical User's Guide to OrbitDB
207 stars 43 forks source link

Update the Precompiled PDF File to Reflect the Recent Changes to the Source Markdown Files #120

Closed yasurok closed 3 years ago

yasurok commented 3 years ago

I --- along with all the others who are trying their hand at OrbitDB for the first time --- would appreciate it very much if you could update the PDF of the Field Manual because it does not seem to reflect the recent changes to the source Markdown files.

CSDUMMI commented 3 years ago

Is it so hard to run npm run build? I didn't get it running, but I thought that was because of my own setup.

aphelionz commented 3 years ago

No, @yasurok is right.

I dont think the onus should be on somebody to run npm run build locally. This should be wired into CI/CD and updated automatically with each commit to the markdown files (probably along with an HTML version too as that has been requested)

CSDUMMI commented 3 years ago

Using GitHub Actions?

aphelionz commented 3 years ago

Sure, or CircleCI, or anything like that

CSDUMMI commented 3 years ago

I would want to design a CI Job that did:

  1. Install pandoc
  2. Compile the PDF and other formats we might like to publish in. #129
  3. Add and pin it to IPFS

The CID of the new dist/ folder could then be used to retrieve it.

But for GitHub Actions it seems, that we need a IPFS Cluster setup to add files to IPFS.

CSDUMMI commented 3 years ago

anything new about this issue? Maybe somebody should update the PDF manually, while no CD Job is implemented

aphelionz commented 3 years ago

I believe this has been satisfied by my updating the /dist files manually.