sap-archive/docpad-skeleton-apidocs

API documentation template for DocPad. Demo:

docpad-skeleton-apidocs's Issues

Update build.zip

Due to change link to build.zip we need update it in config

Interactive tutorials on GH Pages not working

Interactive tutorials on GH Pages not working, urls in build dir are hardcoded to localhost

Fix metadata validator

On skeleton fail we want to know what is wrong and what file should we fix.
For example "Unable to parse." errors

GitHub pages are not working

there is a problem with src/raw/bower_components/list.js/docu file
temp fix, script:

"preparePushResult": "gulp preparePushResult && del-cli src/raw/bower_components/list.js/docs",

long term fix, proper cleanup of generated sources to not deploy not needed files

Push .nojekyll

Due to chewie update file .nojekyll has to be passed explicitly to preparePushResult

Configure TravisCI

AC:

• After each PR, simple scenario should be run automatically
• Scenario: prepare => init => compile => preparePushResults => pushResults (to GitHub pages)
• Run it on few NodeJS versions: 4.2.1, 6.9.0

Support "Security" documents

Support "Security" documents for services

AC

• on services left nav between Glossary and Tutorials, we should be able to add "Security". Now we are hardcoded for particular titles.
• modify placeholder to accept new type of title

[Enable customization] General navigation

top nav configurable through some json/yaml that you can pass into the skeleton and define: what is the name of the navigation node and relative path

enable s3 support on chewieConfig

add configuration for s3 to enable s3 usage inside docker image

adding docu about build automation

Explain how to use TravisCI to automate building of the API Documentation site on GitHub pages

Wrong sample data reposiotry

Instead of docpad-skeleton-apidocs-sampledata use chewie-sample-data.

Use chewie from npm

Right now we clone it "as is" from Github master branch, move it to npm