operationcode_frontend icon indicating copy to clipboard operation
operationcode_frontend copied to clipboard

serve documentation files using docsify

Open talbshoam opened this issue 7 years ago • 13 comments

Description of changes

Use Docsify to serve front-end documentation files

Issue Resolved

Fixes #518

talbshoam avatar Oct 05 '17 15:10 talbshoam

Hey Tal, in the interest of time, how should one go about testing this?

kylemh avatar Oct 05 '17 16:10 kylemh

Once the the build is complete you can simply type docsify serve docs in the terminal and go to localhost:3000 to view the readme or localhost:3000/#/CONTRIBUTING to view the contributing file. I'm not really sure how are we going to integrate it with the website though.

talbshoam avatar Oct 05 '17 16:10 talbshoam

Hey Tal, did you add docsify as a dev dependency? I am getting an error that docsify doesn't exist.

Cooperbuilt avatar Oct 05 '17 16:10 Cooperbuilt

How do I do that? I added it to the package.json file

talbshoam avatar Oct 05 '17 16:10 talbshoam

yarn add docsify --dev or npm install docsify --dev

Cooperbuilt avatar Oct 05 '17 17:10 Cooperbuilt

@Cooperbuilt @tal87 it was added as a dependency, but the yarn.lock file was not added. Running yarn install when inspecting this branch should fix the issue. If it's supposed to be a DEV dependency, then the edit to package.json will need to moved accordingly.

kylemh avatar Oct 05 '17 17:10 kylemh

Unsuccessful for me with yarn install, tested that as well

Cooperbuilt avatar Oct 05 '17 17:10 Cooperbuilt

I ran yarn install and now I see docsify in the yarn.lock file. Should I just commit it?

talbshoam avatar Oct 05 '17 17:10 talbshoam

@tal87 please.

kylemh avatar Oct 05 '17 17:10 kylemh

Done!

talbshoam avatar Oct 05 '17 17:10 talbshoam

I'm putting this on hold until I discuss with our infrastructure team how to best deploy this to a subdomain. It could be that this work will be the initial commit of a completely separate repository. I'm super excited to get documentation up in this manner though - thank you for moving us one huge leap forward.

kylemh avatar Oct 07 '17 06:10 kylemh

@kylemh Did you ever get clarification re the subdomain?

dmarchante avatar Jul 14 '18 21:07 dmarchante

It was on Infra's roadmap, along with many other items, I'm sure.

kylemh avatar Jul 14 '18 22:07 kylemh