Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clinical-meteor/framework-doc-generator
Framework document generator for the Clinical Meteor track, using meteor-jsdocs.
https://github.com/clinical-meteor/framework-doc-generator
Last synced: about 1 month ago
JSON representation
Framework document generator for the Clinical Meteor track, using meteor-jsdocs.
- Host: GitHub
- URL: https://github.com/clinical-meteor/framework-doc-generator
- Owner: clinical-meteor
- Created: 2015-12-05T23:44:30.000Z (about 9 years ago)
- Default Branch: develop
- Last Pushed: 2018-07-04T16:02:17.000Z (over 6 years ago)
- Last Synced: 2024-10-29T21:06:25.545Z (2 months ago)
- Language: JavaScript
- Homepage: http://clinical-docs.meteor.com
- Size: 31.1 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
## framework-doc-generator
Use this app to generate the API documentation for a framework or track.
[http://clinical-docs.meteor.com](http://clinical-docs.meteor.com)
[](https://circleci.com/gh/clinical-meteor/framework-doc-generator/tree/master)
==============================
#### Installation
````bash
# clone the repo to your local workstation
git clone http://github.com/clinical-meteor/framework-doc-generator release-docs
## install the clinical-jsdoc
#cd meteor-jsdoc
#npm install -g . # may need sudo
# initialize your submodules if needed
#git submodule foreach git pull origin master
#git submodule sync
#git submodule update --init --recursive # use submodules#
# fetch the latest packages we want to scrape documentation from
cd ../playerpiano
starrynight fetch
````
==============================
#### Running Verification Tests across the Release Track (React)
````bash
cd ../playerpiano-react
# fetch the latest packages we want to run QA tests on
starrynight fetch
# install dev dependencies
meteor npm install
## run tests on framework, and publish to continuous integration servers
#meteor npm run-script cli-integration-tests
meteor npm run-script package-integration-tests
````
====================================================
#### Adding New Packages to the Release Track
```bash
cd playerpiano/packages
# update the manifest of the packages that get pull into the local repository to do QA check on
nano git-packages.json
# fetch the packages
starrynight fetch
# fetch the packages
meteor add clinical:new-package
# and later, when ready to actually publish
nano clinical.meteor.json
```
==============================
#### Generating Documentation
````bash
cd playerpiano/packages
# build the docs
meteor-jsdoc init
meteor-jsdoc build
meteor-jsdoc start
# docs should now be available at http://localhost:3333
## deploy/publish the docs for a release
cd ../webapp
meteor deploy release-docs.meteor.com
````
==============================
#### Publishing
```bash
meteor publish-release clinical.meteor.rc17.json
```
=====================================
#### Continuous Integration Status
https://circleci.com/gh/clinical-meteor/framework-doc-generator
==============================
#### Licensing
MIT. Use as you will.