/mobile-docs-midstream

https://finp.github.io/mobile-docs-midstream/index.html

Primary LanguageHTML

Mobile Services Downstream Documentation

This repo is used to publish content from https://github.com/aerogear/mobile-docs/ All content must be edited upstream.

Updating documentation

To update all files, run the following script while in the root folder:

./bin/fetch-all.sh

To update downstream documentation:

./bin/fetch-upstream.sh <directory>/<guide-name>.adoc

This updates the master.adoc file:

  • if upstream-location is set to remote, it picks up the adoc from mobile-docs:master.

  • if upstream-location is set to local, it picks up the adoc from a specified local directory.

Note
For pushing to pantheon, always use a remote location, eg:
:upstream-location: https://mobile-docs.netlify.com
// :upstream-location: ../../mobile-docs/build/site
Note
Making changes upstream and previewing the results
You must have mobile-docs and mobile-docs-downstream in the same parent directory.

To make changes upstream and preview them downstream:

  1. Edit the upstream docs, eg

    cd ../mobile-docs
    atom .
  2. Preview the upstream site:

    cd bin
    ./netlify-build.sh

    This generates the required adoc in the mobile-docs/build/site directory.

  3. Update the master.adoc:

    cd ../../mobile-docs-downstream
    ./bin/fetch-upstream.sh <directory>/<guide-name>.adoc
  4. Run ccutil.