https://github.com/pwright/mobile-docs-midstream
https://finp.github.io/mobile-docs-midstream/index.html
https://github.com/pwright/mobile-docs-midstream
Last synced: 3 months ago
JSON representation
https://finp.github.io/mobile-docs-midstream/index.html
- Host: GitHub
- URL: https://github.com/pwright/mobile-docs-midstream
- Owner: pwright
- Created: 2019-08-12T12:47:03.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-09-26T00:30:57.000Z (over 6 years ago)
- Last Synced: 2025-06-14T23:04:34.340Z (about 1 year ago)
- Language: HTML
- Homepage:
- Size: 6.36 MB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.adoc
- Security: security/master-docinfo.xml
Awesome Lists containing this project
README
= Mobile Services Downstream Documentation
This repo is used to publish content from https://github.com/aerogear/mobile-docs/
All content must be edited upstream.
* link:getting-started/master.adoc[Getting Started]
* link:sync/master.adoc[Data Sync]
* link:push/master.adoc[Push Notifications]
* link:idm/master.adoc[Identity Management]
* link:security/master.adoc[Security]
* link:showcase/master.adoc[Showcase App]
.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 /.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
----
.Making changes upstream and previewing the results
NOTE: You must have `mobile-docs` and `mobile-docs-downstream` in the same parent directory.
To make changes upstream and preview them downstream:
. Edit the upstream docs, eg
+
----
cd ../mobile-docs
atom .
----
. Preview the upstream site:
+
----
cd bin
./netlify-build.sh
----
+
This generates the required adoc in the mobile-docs/build/site directory.
. Update the `master.adoc`:
+
----
cd ../../mobile-docs-downstream
./bin/fetch-upstream.sh /.adoc
----
. Run ccutil.