Skip to content

Commit

Permalink
fix: remove docs.openf2.org
Browse files Browse the repository at this point in the history
  • Loading branch information
brianbaker committed May 5, 2022
1 parent ec5828f commit 8d71e1d
Show file tree
Hide file tree
Showing 17 changed files with 36 additions and 40 deletions.
2 changes: 0 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,6 @@ The latest F2 changes can be found in the `*-wip` branch. This branch's name use

Do not work directly in `master`!

![Branches](http://docs.openf2.org/img/branches.png)

### Steps

Once you've forked the F2 repository:
Expand Down
Binary file modified F2-examples.zip
Binary file not shown.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

<img src="http://www.gravatar.com/avatar/81a91ece480ee15ae86a26a7a818b620.png?s=128" align="right">

The goal of F2 is to define a [development standard](http://docs.openf2.org) for the financial services industry that offers a cost saving, risk-reducing method for building innovative, multi-provider solutions.
The goal of F2 is to define a [development standard](https://openf2.github.io/F2) for the financial services industry that offers a cost saving, risk-reducing method for building innovative, multi-provider solutions.

F2 makes **integration** simple, standardized and modern. It's the next-generation of content integration created by [the team](http://www.markit.com/Product/Markit-On-Demand) who has the most experience developing integrated solutions in financial services.

## Demos

Visit [docs.openf2.org](http://docs.openf2.org/index.html#examples) for a list of all available demos, including [jsFiddle](http://jsfiddle.net/user/OpenF2js/fiddles/) and [Codepen](http://codepen.io/OpenF2/) examples.
Visit [openf2.github.io/F2](https://openf2.github.io/F2/index.html#examples) for a list of all available demos, including [jsFiddle](http://jsfiddle.net/user/OpenF2js/fiddles/) and [Codepen](http://codepen.io/OpenF2/) examples.

## Contributing

Expand All @@ -22,14 +22,14 @@ Join the team and help contribute to F2 on GitHub. Begin by reading our [contrib

### Get F2.js

- Choose a [F2.js package](http://docs.openf2.org/f2js-sdk.html#packages), including [F2.basic.js](https://raw.github.com/OpenF2/F2/master/sdk/packages/f2.basic.min.js) (7kb, minified and gzipped)
- Choose a [F2.js package](https://openf2.github.io/F2/f2js-sdk.html#packages), including [F2.basic.js](https://raw.github.com/OpenF2/F2/master/sdk/packages/f2.basic.min.js) (7kb, minified and gzipped)
- Grab any version of F2 [on cdnjs.com](http://cdnjs.com/libraries/F2/).
- For .NET developers: install the [NuGet Package](https://nuget.org/packages/F2/) or `PM> Install-Package F2`
- Bower: `bower install F2`

### Docs

The F2 development standard and API docs are available at [docs.openf2.org](http://docs.openf2.org).
The F2 development standard and API docs are available at [openf2.github.io/F2](https://openf2.github.io/F2).

### Contributions

Expand Down Expand Up @@ -61,7 +61,7 @@ For more information on SemVer, please visit [SemVer.org](http://semver.org/).

#### Upgrading

It is our goal to make upgrading to the latest version of F2 a minor effort for development teams. [Read more in the Docs](http://docs.openf2.org/f2js-sdk.html#upgrading).
It is our goal to make upgrading to the latest version of F2 a minor effort for development teams. [Read more in the Docs](https://openf2.github.io/F2/f2js-sdk.html#upgrading).

### Issues, Enhancements, Bugs

Expand Down
12 changes: 6 additions & 6 deletions docs/src/app-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ _Interested in developing F2 containers? [Browse to Container Development](conta

To help you get started building an F2 app, review the documentation and examples below. To jump start your F2 container or app development, download the F2 example container and apps.

<p><a href="http://docs.openf2.org/F2-examples.zip" class="btn btn-primary btn-small">Download F2 Examples</a></p>
<p><a href="https://openf2.github.io/F2/F2-examples.zip" class="btn btn-primary btn-small">Download F2 Examples</a></p>

### Basic Container

Expand Down Expand Up @@ -53,7 +53,7 @@ Setup a basic container HTML template (or add F2.js to an existing website):
var _appConfig = {
appId: 'com_openf2_examples_javascript_helloworld',
manifestUrl:
'http://docs.openf2.org/demos/apps/JavaScript/HelloWorld/manifest.js'
'https://openf2.github.io/F2/demos/apps/JavaScript/HelloWorld/manifest.js'
};

$(function () {
Expand All @@ -80,7 +80,7 @@ Good news! In the [project repo on GitHub](https://github.com/OpenF2/F2/tree/mas

These examples are also available in a separate archive if you don't want to download the entire repository.

<p><a href="http://docs.openf2.org/F2-examples.zip" class="btn btn-primary btn-small">Download F2 Examples</a></p>
<p><a href="https://openf2.github.io/F2/F2-examples.zip" class="btn btn-primary btn-small">Download F2 Examples</a></p>

### Configuration

Expand Down Expand Up @@ -143,7 +143,7 @@ Once you have your AppID, start by setting up your project. You will need at lea

![](./img/project_folder.png 'Setup your project')

<span class="label label-default">Helper</span> [Download the F2 examples](http://docs.openf2.org/F2-examples.zip) or read about [setting up a basic container and app](#get-started) in Getting Started.
<span class="label label-default">Helper</span> [Download the F2 examples](https://openf2.github.io/F2/F2-examples.zip) or read about [setting up a basic container and app](#get-started) in Getting Started.

### App Manifest

Expand Down Expand Up @@ -332,7 +332,7 @@ F2_jsonpCallback_com_companyname_appname({

### App Manifest Response

OK, so you know about F2 apps and you're ready to write your own App Manifest. To go from zero to _something_, [download the F2 examples](http://docs.openf2.org/F2-examples.zip). Once you have your `AppManifest` defined (or at least stubbed out), there's one important detail you need to know now&mdash;the App Manifest response format.
OK, so you know about F2 apps and you're ready to write your own App Manifest. To go from zero to _something_, [download the F2 examples](https://openf2.github.io/F2/F2-examples.zip). Once you have your `AppManifest` defined (or at least stubbed out), there's one important detail you need to know now&mdash;the App Manifest response format.

As part of F2, containers register apps&mdash;typically hosted on different domains&mdash;using JSONP. **This means F2 App Manifest files must provide a JSONP callback function.** (If you don't know what JSONP is or how it works, we recommend [reading what Remy Sharp has to say](http://remysharp.com/2007/10/08/what-is-jsonp/) about it.)

Expand Down Expand Up @@ -492,7 +492,7 @@ Of course, you don't have to use either one of these patterns in your `appclass.
<p>In the absence of a function in your `appclass.js`, F2 will be unable to load your app on a container.</p>
</div>

If you don't want to think about any of this and would rather just start coding, [download the F2 examples](http://docs.openf2.org/F2-examples.zip).
If you don't want to think about any of this and would rather just start coding, [download the F2 examples](https://openf2.github.io/F2/F2-examples.zip).

---

Expand Down
8 changes: 4 additions & 4 deletions docs/src/container-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The container is the foundation of any F2-enabled solution. By leveraging the [F

To help you get started building an F2 container, review the documentation and examples below. To jump start your F2 container or app development, download the F2 example container and apps.

<p><a href="http://docs.openf2.org/F2-examples.zip" class="btn btn-primary btn-small">Download F2 Examples</a></p>
<p><a href="https://openf2.github.io/F2/F2-examples.zip" class="btn btn-primary btn-small">Download F2 Examples</a></p>

### Basic Example

Expand Down Expand Up @@ -40,7 +40,7 @@ Setup a basic container HTML template (or add F2.js to an existing website):
var _appConfig = {
appId: 'com_openf2_examples_javascript_helloworld',
manifestUrl:
'http://docs.openf2.org/demos/apps/JavaScript/HelloWorld/manifest.js'
'https://openf2.github.io/F2/demos/apps/JavaScript/HelloWorld/manifest.js'
};

$(function () {
Expand All @@ -67,7 +67,7 @@ Good news! In the [project repo on GitHub](https://github.com/OpenF2/F2/tree/mas

These examples are also available in a separate archive if you don't want to download the entire repository.

<p><a href="http://docs.openf2.org/F2-examples.zip" class="btn btn-primary btn-small">Download F2 Examples</a></p>
<p><a href="https://openf2.github.io/F2/F2-examples.zip" class="btn btn-primary btn-small">Download F2 Examples</a></p>

### Integrating Apps

Expand Down Expand Up @@ -874,7 +874,7 @@ F2 will insert `html` from the `AppManifest` inside the specified DOM element. T
</div>
```

<span class="label label-info">Note</span> The original `html` in this example app manifest is [available here](http://docs.openf2.org/demos/apps/JavaScript/HelloWorld/manifest.js).
<span class="label label-info">Note</span> The original `html` in this example app manifest is [available here](https://openf2.github.io/F2/demos/apps/JavaScript/HelloWorld/manifest.js).

The jsfiddle below demonstrates a Hello World example using the `appRender` event type and a DOM element as the third argument in `on`.

Expand Down
4 changes: 2 additions & 2 deletions docs/src/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ sources and, using [F2 Context](container-development.html#context), seamlessly

<p>
We've built-in some keyboard shortcuts to highlight individual F2 components.
Press <code>c</code> to see the <a href="http://docs.openf2.org/container-development.html">F2 Container</a> highlighted (and Apps blurred).
Press <code>a</code> to see the <a href="http://docs.openf2.org/app-development.html">F2 Apps</a>. (Press again to disable.)</p>
Press <code>c</code> to see the <a href="https://openf2.github.io/F2/container-development.html">F2 Container</a> highlighted (and Apps blurred).
Press <code>a</code> to see the <a href="https://openf2.github.io/F2/app-development.html">F2 Apps</a>. (Press again to disable.)</p>

## Apps

Expand Down
4 changes: 2 additions & 2 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,10 @@ There are a few different types of examples available below.
</div>

<div class="media">
<a class="media-left" href="http://docs.openf2.org/F2-examples.zip"><i class="fa fa-download"></i></a>
<a class="media-left" href="https://openf2.github.io/F2/F2-examples.zip"><i class="fa fa-download"></i></a>
<div class="media-body">
<h4 class="media-heading">Download</h4>
A variety of example Containers and Apps to [download](http://docs.openf2.org/F2-examples.zip) and run on your localhost. Most are "plain" javascript, others are written in .NET, PHP and Node.js. The [examples source code is also on GitHub](https://github.com/OpenF2/F2/tree/master/examples).
A variety of example Containers and Apps to [download](https://openf2.github.io/F2/F2-examples.zip) and run on your localhost. Most are "plain" javascript, others are written in .NET, PHP and Node.js. The [examples source code is also on GitHub](https://github.com/OpenF2/F2/tree/master/examples).
</div>
</div>

Expand Down
4 changes: 2 additions & 2 deletions docs/src/sdk-template/layouts/main.handlebars
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
}
</style>
<script type="text/javascript">
if ((/docs.openf2.org/i).test(window.location.hostname)) {
if ((/openf2.github.io/i).test(window.location.hostname)) {
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-35230380-1']);
_gaq.push(['_setDomainName', 'openf2.org']);
Expand Down Expand Up @@ -145,7 +145,7 @@
<p>F2 is governed by its Advisory Board, and maintained by <a href="http://www.markit.com/product/markit-on-demand">Markit On Demand</a> on GitHub. F2 is licensed under the Apache 2.0 License.</p>
</div>
<ul class="nav navbar-nav hidden-sm hidden-md hidden-lg list">
<li><a href="http://docs.openf2.org">Docs</a></li>
<li><a href="https://openf2.github.io/F2">Docs</a></li>
<li><a href="https://github.com/OpenF2/F2">GitHub</a></li>
</ul>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/src/sdk-template/partials/index.handlebars
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,13 @@ There are a few different types of examples available below.
</div>

<div class='media'>
<a class='media-left' href='http://docs.openf2.org/F2-examples.zip'><i
<a class='media-left' href='https://openf2.github.io/F2/F2-examples.zip'><i
class='fa fa-download'
></i></a>
<div class='media-body'>
<h4 class='media-heading'>Download</h4>
A variety of example Containers and Apps to
<a href='http://docs.openf2.org/F2-examples.zip'>download</a>
<a href='https://openf2.github.io/F2/F2-examples.zip'>download</a>
and run on your localhost. Most are "plain" javascript, others are written
in .NET, PHP and Node.js. The
<a href='https://github.com/OpenF2/F2/tree/master/examples'>examples source
Expand Down
2 changes: 1 addition & 1 deletion docs/src/template/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ <h1 class="hidden-sm hidden-md hidden-lg">F2</h1>
</p>
</div>
<ul class="nav navbar-nav hidden-sm hidden-md hidden-lg list">
<li><a href="//docs.openf2.org">Docs</a></li>
<li><a href="https://openf2.github.io/F2">Docs</a></li>
<li><a href="https://github.com/OpenF2/F2">GitHub</a></li>
</ul>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/src/template/head.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
><![endif]-->
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
<script type="text/javascript">
if (/docs.openf2.org/i.test(window.location.hostname)) {
if (/openf2.github.io/i.test(window.location.hostname)) {
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-35230380-1']);
_gaq.push(['_setDomainName', 'openf2.org']);
Expand Down
4 changes: 2 additions & 2 deletions examples/container-amd/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta name="author" content="" />
<link
rel="shortcut icon"
href="//docs.openf2.org/img/favicon.ico"
href="https://openf2.github.io/F2/img/favicon.ico"
type="image/x-icon"
/>
<title>F2 - Container (AMD) Example</title>
Expand Down Expand Up @@ -68,7 +68,7 @@
<li><a href="../container-autoload/index.html">Autoload</a></li>
</ul>
</li>
<li><a href="http://docs.openf2.org" target="_blank">Docs</a></li>
<li><a href="https://openf2.github.io/F2" target="_blank">Docs</a></li>
<li class="divider-vertical"></li>
<li>
<a href="https://github.com/OpenF2/F2" target="_blank">GitHub</a>
Expand Down
4 changes: 2 additions & 2 deletions examples/container-autoload/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta name="author" content="" />
<link
rel="shortcut icon"
href="//docs.openf2.org/img/favicon.ico"
href="https://openf2.github.io/F2/img/favicon.ico"
type="image/x-icon"
/>
<title>F2 - Container Autoload Example</title>
Expand Down Expand Up @@ -67,7 +67,7 @@
<li class="active"><a href="./index.html">Autoload</a></li>
</ul>
</li>
<li><a href="http://docs.openf2.org" target="_blank">Docs</a></li>
<li><a href="https://openf2.github.io/F2" target="_blank">Docs</a></li>
<li class="divider-vertical"></li>
<li>
<a href="https://github.com/OpenF2/F2" target="_blank">GitHub</a>
Expand Down
4 changes: 2 additions & 2 deletions examples/container-locale/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta name="author" content="" />
<link
rel="shortcut icon"
href="//docs.openf2.org/img/favicon.ico"
href="https://openf2.github.io/F2/img/favicon.ico"
type="image/x-icon"
/>
<title>F2 - Container Example</title>
Expand Down Expand Up @@ -82,7 +82,7 @@
<li><a href="#" data-locale="en-gb">en-gb</a></li>
</ul>
</li>
<li><a href="http://docs.openf2.org" target="_blank">Docs</a></li>
<li><a href="https://openf2.github.io/F2" target="_blank">Docs</a></li>
<li class="divider-vertical"></li>
<li>
<a href="https://github.com/OpenF2/F2" target="_blank">GitHub</a>
Expand Down
4 changes: 2 additions & 2 deletions examples/container/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta name="author" content="" />
<link
rel="shortcut icon"
href="//docs.openf2.org/img/favicon.ico"
href="https://openf2.github.io/F2/img/favicon.ico"
type="image/x-icon"
/>
<title>F2 - Container Example</title>
Expand Down Expand Up @@ -68,7 +68,7 @@
<li><a href="../container-autoload/index.html">Autoload</a></li>
</ul>
</li>
<li><a href="http://docs.openf2.org" target="_blank">Docs</a></li>
<li><a href="https://openf2.github.io/F2" target="_blank">Docs</a></li>
<li class="divider-vertical"></li>
<li>
<a href="https://github.com/OpenF2/F2" target="_blank">GitHub</a>
Expand Down
6 changes: 2 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"docs": "rm -rf ./docs/dist && webpack --config ./docs/src/webpack.config.js && node docs/bin/gen-docs && node docs/bin/yuidocs && rm docs/dist/css/site.js && cp -r docs/src/img docs/src/fonts docs/src/apps docs/src/js docs/dist && cp dist/* docs/dist/js",
"docs-live": "http-server ./docs/dist",
"examples": "http-server ./ -o /examples/container/index.html",
"gh-pages": "cp -r docs/dist/* ../gh-pages && cp dist/* ../gh-pages && npm run zip",
"gh-pages": "rm -rf ../gh-pages/* && cp -r docs/dist/* ../gh-pages && cp dist/* ../gh-pages && npm run zip",
"lint": "eslint src/ && prettier --check .",
"test": "npm run lint && concurrently -s first -k -r \"cross-env PORT=8080 node tests/server\" \"cross-env PORT=8081 node tests/server\" \"karma start --single-run --browsers ChromeHeadless --reporters nested\"",
"test-debug": "npm run lint && concurrently -s first -k -r \"cross-env PORT=8080 node tests/server\" \"cross-env PORT=8081 node tests/server\" \"karma start --log-level debug --single-run --browsers ChromeHeadless --reporters nested\"",
Expand Down Expand Up @@ -74,7 +74,5 @@
],
"engines": {
"node": ">=6"
},
"_releaseDate": "2018-03-02T20:52:10.133Z",
"_releaseDateFormatted": "2 March 2018"
}
}
2 changes: 1 addition & 1 deletion tests/server.js
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ app.all('/F2/apps/test/hello-world-node', function (req, res) {
],
apps: [
{
html: '<div><div data-f2-view="home" class="f2-app-view"><h1 class="page-header">Hello, World!</h1><p class="lead">This demonstrates a simple "Hello World" F2 App. </p><h4>Container Developers</h4><p>If you\'re a Container Provider and want to learn how to integrate F2 into your website, <a href="http://docs.openf2.org/container-development.html#developing-f2-containers">browse to the Container docs</a>.</p><h4>App Developers</h4><p>If you\'re an App Provider and want to learn how to build F2 apps, <a href="http://docs.openf2.org/app-development.html#developing-f2-apps">browse to the App docs</a>.</p><hr/><p>Get your hands on an example F2 Container and Apps! </p><button onclick="location.href=&quot;http://docs.openf2.org/F2-examples.zip&quot;" class="btn btn-primary">Download F2 Examples</button></div></div>',
html: '<div><div data-f2-view="home" class="f2-app-view"><h1 class="page-header">Hello, World!</h1><p class="lead">This demonstrates a simple "Hello World" F2 App. </p><h4>Container Developers</h4><p>If you\'re a Container Provider and want to learn how to integrate F2 into your website, <a href="https://openf2.github.io/F2/container-development.html#developing-f2-containers">browse to the Container docs</a>.</p><h4>App Developers</h4><p>If you\'re an App Provider and want to learn how to build F2 apps, <a href="https://openf2.github.io/F2/app-development.html#developing-f2-apps">browse to the App docs</a>.</p><hr/><p>Get your hands on an example F2 Container and Apps! </p><button onclick="location.href=&quot;https://openf2.github.io/F2/F2-examples.zip&quot;" class="btn btn-primary">Download F2 Examples</button></div></div>',
status: 'success'
}
]
Expand Down

0 comments on commit 8d71e1d

Please sign in to comment.