Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update raincatcher documentation #18

Merged
merged 5 commits into from
Sep 11, 2017
Merged
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
7 changes: 5 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
language: ruby
dist: trusty
rvm:
- 2.3.3

# Assume bundler is being used, therefore
# the `install` step will run `bundle install` by default.
script:
- bundle exec jekyll build
- bundle exec htmlproofer ./_site --url-ignore "/#/"
- bundle exec htmlproofer ./_site --url-ignore "/#/,/www.mankier.com/"

sudo: false
sudo: required
before_install:
- sudo update-ca-certificates
76 changes: 3 additions & 73 deletions projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,83 +86,13 @@ A set of Node.js modules that can be used with FeedHenry to develop workforce
management (WFM) applications.

</div>

<div class="project-text" markdown="1">

<img src="{{ "/assets/images/raincatcher.svg" | relative_url }}" alt="RainCatcher Logo" class="project-logo" />

#### Overview

RainCatcher modules are packaged and distributed via [npm]. They are designed to
be included in your application using [Browserify]. RainCatcher modules export
one or more of:

* [Angular.js 1] directives or services providing client-side functionality for
both the mobile and portal clients.
* [Express.js] routes providing a REST API to be consumed by the client-side
portions of the module.
* FeedHenry sync configurations for enabling data synchronization of a module's
data. Each module's README file includes more detail on its purpose and how to
use it.

[npm]: https://www.npmjs.com/
[browserify]: http://browserify.org/
[Angular.js 1]: https://angularjs.org/
[Express.js]: http://expressjs.com/

#### Getting Started

See the [Getting Started Guide](https://github.com/feedhenry-raincatcher/raincatcher-documentation/blob/master/getting-started.adoc).

#### Community
### RainCatcher Resources

* [RainCatcher project website](http://raincatcher.feedhenry.io)
* [feedhenry-raincatcher mailing list](http://www.redhat.com/mailman/listinfo/feedhenry-raincatcher)
* [IRC: #feedhenry-raincatcher on Freenode](irc://irc.freenode.net/feedhenry-raincatcher)

#### FAQ

###### What's the release cycle for RainCatcher?

We have not yet developed a schedule for releases. RainCatcher is still in rapid
development, and we're going to be working with the larger community to develop
a cadence.

###### What's the relationship between RainCatcher and RHMAP WFM?

RainCatcher is the upstream project for WFM, where we do work before pulling
it into our supported product. Features in RainCatcher may or may not ultimately
land in WFM.

###### I'd like to contribute, do I need to sign a CLA?

No, we do not have a CLA for RainCatcher, but contributors do acknowledge that
work contributed to RainCatcher is their own work and they have the right to
make a copyright.

If you have more questions, you are welcome to ask them on the [feedhenry-raincatcher mailing list].

[feedhenry-raincatcher mailing list]: http://www.redhat.com/mailman/listinfo/feedhenry-raincatcher

#### Modules

###### Visual components

{% include repos.html repos="raincatcher-signature,raincatcher-map" %}

###### Angular services and directives

{% include repos.html repos="raincatcher-workflow,raincatcher-workorder,raincatcher-user,raincatcher-risk-assessment,raincatcher-vehicle-inspection,raincatcher-schedule" %}

###### Low-level modules

{% include repos.html repos="raincatcher-sync,raincatcher-appform,raincatcher-mediator" %}

Find the complete list of modules [here](https://github.com/feedhenry-raincatcher).

</div>


<div class="project-title" markdown="1">
* [RainCatcher chat](https://gitter.im/FeedhenryRaincatcher/Lobby)

## MBaaS

Expand Down