Skip to content

Commit

Permalink
Merge remote-tracking branch 'jon/FLUID-5840'
Browse files Browse the repository at this point in the history
* jon/FLUID-5840:
  FLUID-5840: Fixed bad links in 404 page.
  FLUID-5840: Fixed link to metadata demo.
  FLUID-5840: fixed 404 page and redirects
  NO-JIRA: Updated readme to fix MD formatting.
  NO-JIRA: Fixed a numbering problem.
  NO-JIRA: Updated readme.
  • Loading branch information
acheetham committed Jan 14, 2016
2 parents b35f571 + 350d0fd commit 0cc7ba4
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 34 deletions.
34 changes: 15 additions & 19 deletions README.md
Expand Up @@ -4,32 +4,28 @@ This repository contains the files needed to build a copy of the Fluid Project w

This is not an immediately deployable version of the website - [docpad](http://docpad.org/) is used to build the site from source files.

# To Build
# To Build Locally

1. Edit ``docpad.coffee`` URL value to reflect your target URL (with no trailing slash). The default value is ``http://localhost:9778``. Example:
```
url: "username.github.io/fluidproject.org"
```
1. Install DocPad if it isn't already installed: `sudo npm install -g docpad`

2. Run docpad from the fluid-website directory
```
> cd fluidproject.org
> docpad run
```
3. Open ```http://localhost:9778/``` to see the website. This URL will be different if you changed the URL value in step 1.
2. Get the required node modules: `npm install`

3. Edit `docpad.coffee` URL value to reflect your target URL (with no trailing slash). The default value is `http://localhost:9778`. For local testing and development, you should keep this default value.

4. Run docpad from the fluid-website directory `docpad run`.

5. Open `http://localhost:9778/` to see the website.

# To deploy to gh-pages:
1. Change the ``url:`` value in the docpad.coffee to match your deployed gh-pages URL.
2. Deploy to gh-pages, run: ``` > docpad deploy-ghpages --env static ```

This will:
- create generate output files under the ``/out/`` directory
- create a new ``gh-pages`` branch in the remote origin github repository
- push the files in the ``out`` directory to the remote ``gh-pages`` branch on origin.
1. Start by working from a clone of the repository you want to deploy to. This step is important, otherwise your output may deploy to the wrong location.

2. Change the ``url:`` value in the docpad.coffee to match your deployed gh-pages URL. If you intend to deploy to a custom domain, the URL value should match the target URL: `url: "www.example.com"`
If deploying to gh-pages URL, the URL would look like this: `url: "username.github.io/fluidproject.org"`
3. Deploy to gh-pages, run: `docpad deploy-ghpages --env static`. By doing this, docpad will generate the site to the remote gh-pages branch.

For more information on the gh-pages plugin, see: https://github.com/docpad/docpad-plugin-ghpages.
# To deploy to a personal webserver

# To deploy to a webserver
1. Change the ``url:`` value in the docpad.coffee to match your deployed URL.
2. Run: ``` > docpad generate --env static ```
3. Copy the contents of ```./out/``` directory to your server.
Expand Down
23 changes: 12 additions & 11 deletions docpad.coffee
Expand Up @@ -7,17 +7,18 @@ docpadConfig = {
redirector:
redirects:
# source: destination
"index.php/news":"news.html"
"projects":"projects.html"
"index.php/projects":"projects.html"
"about-us/our-mission":"about.html"
"about-us/our-funder":"about.html"
"about-us/contact-us":"about.html"
"getinvolved":"index.html"
"partners/fluid-academic-partners":"index.html"
"products/infusion/download-infusion":"infusion.html"
"products/infusion":"infusion.html"
"pipermail/fluid-work":"index.html"
"index.php/news":"/news.html"
"projects":"/projects.html"
"index.php/projects":"/projects.html"
"about-us/our-mission":"/about.html"
"about-us/our-funder":"/about.html"
"about-us/contact-us":"/about.html"
"getinvolved":"/index.html"
"partners/fluid-academic-partners":"/index.html"
"products/infusion/download-infusion":"/infusion.html"
"products/infusion":"/infusion.html"
"products/infusion/infusion.html":"/infusion.html"
"pipermail/fluid-work":"http://lists.idrc.ocad.ca/pipermail/fluid-work/"
"pipermail/fluid-announce":"http://lists.idrc.ocad.ca/pipermail/fluid-announce"
"pipermail/infusion-users":"http://lists.idrc.ocad.ca/pipermail/infusion-users"
"pipermail/fluid-talk":"http://lists.idrc.ocad.ca/pipermail/fluid-talk/"
Expand Down
1 change: 0 additions & 1 deletion package.json
Expand Up @@ -7,7 +7,6 @@
"npm": "1.3"
},
"dependencies": {
"docpad": "~6.69.2",
"docpad-plugin-eco": "~2.1.0",
"docpad-plugin-ghpages": "~2.4.3",
"docpad-plugin-handlebars": "~2.3.0",
Expand Down
10 changes: 8 additions & 2 deletions src/documents/404.html
Expand Up @@ -7,10 +7,16 @@
<div class="row">
<h2>Page not found</h2>
<p>
We recently updated this website and we are in the process of restoring some lost content.
The page you requested was not found.
</p>
<h3>Relevant pages</h3>
<p>
In the meantime, please visit the <a href="/">Fluid Project home page</a>.
<ul>
<li><a href="/index.html">Fluid Project home page</a></li>
<li><a href="/projects.html">Our projects</a></li>
<li><a href="/infusion.html">Fluid Infusion</a></li>
<li><a href="/news.html">News</a></li>
</ul>
</p>
</div>
</main>
2 changes: 1 addition & 1 deletion src/documents/projects.html
Expand Up @@ -36,7 +36,7 @@ <h3>Video Player</h3>
<div class="small-10 medium-6 columns fluid-web-project-description">
<h3>Metadata Authoring</h3>
<p>Identify and help people find accessible resources.</p>
<a href="http://metadata.floeproject.org/demos/html/index.html" class="row"><span class="fluid-web-showcase-item-text">Metadata Authoring Demo<span class="fluid-web-external-link" role="presentation"></span></span></a>
<a href="http://metadata.floeproject.org/demos/metadata/index.html" class="row"><span class="fluid-web-showcase-item-text">Metadata Authoring Demo<span class="fluid-web-external-link" role="presentation"></span></span></a>
</div>
</div>
</section>
Expand Down

0 comments on commit 0cc7ba4

Please sign in to comment.