Skip to content

Latest commit

 

History

History
121 lines (93 loc) · 3.66 KB

TasksAndOldReadme.md

File metadata and controls

121 lines (93 loc) · 3.66 KB

Example Single FDC3 Repository and Website

Build Status FINOS - Incubating

This repository demonstrates using Docusaurus to author and host the FDC3 website and documentation, based on markdown files.

Plan

  • Try out Docusaurus
  • Host on GitHub Pages
  • Attempt to apply styling and assets from https://fdc3.finos.org to this website
  • Copy docs from other FDC3 repositories into this single repository
  • Setup CI
  • Copy code/examples from other FDC3 repositories
  • Add docs from use cases
  • Integrate OpenAPI docs for app directory (redoc?)
  • Integrate generated TS docs for API
  • API reference (postponing)
  • Intent reference
  • Versioning
  • About page
  • Community page
  • Extra documentation content
  • Tutorial content (after 1.0)
  • FINOS/Working group info
  • Finalise styling and assets
  • GitHub README must adhere to FINOS standard
  • Present to PMC

For more detail, see the FINOS FDC3 1.0 Release Public Launch Documentation Sub-Plan.

Developer Information

The included example website was generated by following the Docusaurus installation steps.

Required tools

Structure

The repository follows the standard Docusaurus website structure. For more information, see Creating your site. Propose to move the working group github sites under the same structure to simplify

root-directory
├── docs
└── website
    ├── blog
    ├── core
    │   └── Footer.js
    ├── package.json
    ├── pages
    ├── sidebars.json
    ├── siteConfig.js
    └── static
└── src
    ├── api
    ├── app-directory
    ├── context
    ├── intents
└── examples
    ├── context
    ├── intents

Running the website locally

  1. Navigate to the website folder:

    cd website

  2. Install pre-requisites (first time only)

    yarn

  3. Run the local web server:

    yarn start

  4. Navigate to the website: http://localhost:3000

Publishing to GitHub Pages

The following properties were added to website/siteConfig.js:

const siteConfig = {
    url: 'https://rikoe.github.io',
    baseUrl: '/FDC3/',
    projectName: 'FDC3',
    organizationName: 'rikoe'
}

To publish the website, follow this steps:

  1. Navigate to the website folder:

    cd website

  2. Publish:

     GIT_USER=<GIT_USER> USE_SSH=true yarn run publish-gh-pages

This will publish to the gh-pages branch of the repository, which will automatically be hosted on GitHub Pages.

Continuous Integration

The CI build is hosted on Travis CI at https://travis-ci.com/rikoe/FDC3. When new changes are committed to master, Travis will automatically deploy an updated version of the website to GitHub Pages.

For full documentation about publishing Docusaurus websites, see Publishing your site.

For more information about GitHub Pages, see GitHub's FAQ.