Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Single FDC3 repository including documentation website built with Docusaurus #5

Merged
merged 60 commits into from
Feb 15, 2019

Conversation

rikoe
Copy link
Contributor

@rikoe rikoe commented Feb 8, 2019

This addresses #3 and #4 with a combined FDC3 repository and website built with the open source documentation authoring tool Docusaurus from Facebook.

The result can be seen here, hosted on GitHub Pages on my fork: https://rikoe.github.io/FDC3/.

It includes an automated build with Travis CI that will automatically deploy to the above URL.

If the PR is approved and merged, the following steps will need to be taken:

  • Give working group repository administrators admin access to this repository.
  • Remove any hard-coded references and configuration to my fork from the code.
  • Set up an automated build for this repository on Travis CI.
  • Deploy the static website to GitHub Pages for this repository.
  • Point https://fdc3.finos.org to the website.
  • Remove the old partial documentation sites, e.g. https://fdc3-api.finos.org/.
  • Archive working group repositories, and point them to this repository.

rikoe and others added 30 commits January 21, 2019 14:29
Remove website link from main readme (it is now at the top of the repo, where it should be), add FINOS incubating badge.
Use subcategories to designate accepted, in review and rejected use cases.
Reorder first page - updated examples
First pass at a why-fdc3 intro
Espen and others added 23 commits January 24, 2019 14:07
locked docusaurus till we have build fixed
Adding files from FINOS Blueprint
- New use cases section
- Removed tutorial
- Renamed "Blog" to "News"
Made use cases separate top-level item
Add and link static OpenAPI web page generated with redoc
- Turn collapsible sidebar navigation on
- Link to Why FDC3 document
Consolidated API docs and added Footer links
Added the 2 use cases approved on todays Use Case WG
* Rename and add info to Plan.md
* Add Stackoverflow badge to README.md
* Remove references to repository from index.js
@rikoe rikoe mentioned this pull request Feb 8, 2019
16 tasks
@nkolba
Copy link
Contributor

nkolba commented Feb 14, 2019

Looks great @rikoe ! Can we get a second approval from the PMC?

@donbasuno
Copy link
Contributor

Looks good to me too @rikoe @nkolba

@nkolba nkolba merged commit 8ee59a0 into finos:master Feb 15, 2019
WatsonCIQ pushed a commit to WatsonCIQ/FDC3 that referenced this pull request Feb 15, 2021
kriswest pushed a commit that referenced this pull request Oct 14, 2021
robmoffat added a commit to robmoffat/FDC3 that referenced this pull request Jul 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants