Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 1 addition & 32 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,38 +3,7 @@ language: node_js
node_js:
- 6
before_install:
- npm install @dojo/cli grunt-cli typings -g
env:
- TUTORIAL=001_static_content
- TUTORIAL=002_creating_an_application
- TUTORIAL=003_creating_widgets
- TUTORIAL=004_user_interactions
- TUTORIAL=005_form_widgets
- TUTORIAL=006_deploying_to_production
- TUTORIAL=006_containers_and_injecting_state
- TUTORIAL=007_theming
- TUTORIAL=1010_containers_and_injecting_state
- TUTORIAL=1015_form_validation
- TUTORIAL=1020_registries
- TUTORIAL=1030_routing
- TUTORIAL=1050_development_environment
- TUTORIAL=1060_data_driven_widgets
script:
- pushd .
- 'if [ -d "site/source/tutorials/$TUTORIAL/demo/initial/biz-e-corp" ]; then
cd site/source/tutorials/$TUTORIAL/demo/initial/biz-e-corp || travis_terminate 1;
npm install || travis_terminate 1;
npm run build || travis_terminate 1;
fi'
- popd
- pushd .
- 'if [ -d "site/source/tutorials/$TUTORIAL/demo/finished/biz-e-corp" ]; then
cd site/source/tutorials/$TUTORIAL/demo/finished/biz-e-corp || travis_terminate 1;
npm install || travis_terminate 1;
npm run build || travis_terminate 1;
npm test || travis_terminate 1;
fi'
- popd
- npm install grunt-cli -g

jobs:
include:
Expand Down
19 changes: 8 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,10 @@ Static pages are built from markdown located in [`site/source`](https://github.c

### Writing a Tutorial

Tutorials are located in [`site/source/tutorials`](https://github.com/dojo/dojo.io/tree/master/site/source/tutorials) and are similar to static pages. They use the tutorial layout
(`layout: tutorial`) and have code content provided in the `demo` subdirectory that is archived during the tutorials
Tutorials are located in [`site/source/tutorials`](https://github.com/dojo/dojo.io/tree/master/site/source/tutorials) and are similar to static pages. They use the tutorial layout (`layout: tutorial`) and have code content provided in the `demo` subdirectory that is archived during the tutorials
build process (`grunt tutorials`).

If the `finished` directory of the tutorial should be built and tested as part of the CI build, it needs
to be added to the list of `TUTORIAL` values in [.travis.yml](./.travis.yml)
If a tutorial is added or modified, the `grunt precommit` task should be run to test the tutorials locally and store the result, if the tests succeed. If this is not, the CI build will detect this and run the tests automatically. While this ensures that the tutorials will work, it greatly extends the build time and should be avoided.

## API Documentation

Expand All @@ -49,8 +47,8 @@ API documentation is generated using the `grunt api` command to the `_dist/api/<

Building documentation for a project requires the project repository to be checked out to a temporary location where its dependencies are added and `typedoc` is ran against the repository. It is a relatively resource intensive
task.
Missing APIs are built using the `grunt api` task. You can build APIs for a specific project by selecting the

Missing APIs are built using the `grunt api` task. You can build APIs for a specific project by selecting the
appropriate configuration. You can also limit what versions get built using semver matching or the "latest" keyword
either in the grunt configuration of via the `--apiversion` command line argument.

Expand Down Expand Up @@ -97,14 +95,14 @@ API documentation will be built on a nightly cron by Travis. This is a WIP.

### Creating a Staging Environment

This section discusses how to get a complete staging environment working on a `dojo/dojo.io` fork using GitHub and
This section discusses how to get a complete staging environment working on a `dojo/dojo.io` fork using GitHub and
Travis. It is **not necessary** to do this when simply developing content as there is a local development environment
available that you can run on your machine and see changes. You would typically set up a staging environment when you
need to test updates to the continuous deployment scripts or want to host a preview of the site on GitHub.

This process has been largely automated with the `grunt setup --repo='you/dojo.io'` command.
These instructions assume you already have an account on GitHub and Travis and have installed the

These instructions assume you already have an account on GitHub and Travis and have installed the
[Travis command line client](https://blog.travis-ci.com/2013-01-14-new-client/).

1. Fork the `dojo/dojo.io` repo to your GitHub account
Expand All @@ -130,4 +128,3 @@ development pattern is:
### Automated Deploy to Production

TODO: This feature has been temporarily disabled while completing work on dojo/dojo.io. It will work by deploying to the `gh-pages` branch using `grunt publish`.

Loading