FDC3 docs / sites
fdc3.finos.org - public facing documentation for users and evalutaors of FDC3:
Pieces and sections
- Landing page and group docs - the FDC3 microsite: fdc3.finos.org
- GitHub for code repos
- FINOS Wiki, https://finosfoundation.atlassian.net/wiki/spaces/FDC3, for collaboration
- Docs sourced from Github
- FINOS web site program page
Required components of product (FDC3) microsite
- A business overview of the product (i.e., FDC3 standards), its value to organization, and an explanation of what businesses should implement it and/or use/buy software that does implement it -- in layperson’s terms.
- A technical overview of the standards, including any overview of opinionation, preferred design patterns, etc.
- An explanation of how to get involved and contribute (with a link over to the wiki for more information on that)
- An explanation of how the standards (i.e., different work group products) are intended to be used together but also how they can be implemented as a standalone
- A “getting started” guide / cookbook to implementing the standard
- Links to reference implementations
https://github.com/FDC3 - Source code and master for documentation
README.md Requirements
(See Activation section of the Community Handbook for more info)
- “description of the software, including a feature overview”
- “installation & configuration instructions”
- “description of how to use the software”
- “links to other systems (further documentation, continuous integration & validation tools, artifact repository, change log / history, etc.)”
- “Foundation status badge (“Released” when all criteria are met and PMC approves)”
- “Roadmap”
- “copyright & license information”
https://finosfoundation.atlassian.net/wiki/spaces/FDC3 - "The Wiki" - Group collaboration for program participants/interest
The primary purpose
https://www.finos.org/fdc3 - Finos FDC3 intro:
- Links here go to - https://finosfoundation.atlassian.net/wiki/spaces/FDC3, should also include new landing page fdc3.finos.org
Tasks
- Rob Underwood (Deactivated): Build overall plan (this doc)
- Kick start documentation Taskforce (initiate: Espen)
- FINOS (Gabriele Columbro): Information Architecture
- What goes on FINOS.org program page for FDC3 and FINOS.org website more generally?
- What goes on wiki?
- What goes on fdc3.finos.org (fdc3.org), the "main" site, for the product?
- What is the navigational construct of the fdc3.finos.org website?
- What is the navigational construct of the fdc3.finos.org website?
- Rob Underwood (Deactivated): Perform Gap Analysis (What's Missing? What Needs to Get Updated)
- Initial Gap Analysis (FINOS - Rob Underwood (Deactivated) and Tosha Ellison) - In Progress
- What's not written and needs to be?
- Explanation of how FDC3 can be consumed (how can it be used and implemented)
- What needs to be revised, expanded, and/or editeD?
- What's not written and needs to be?
- Identify actions and remedies
- Initial Gap Analysis (FINOS - Rob Underwood (Deactivated) and Tosha Ellison) - In Progress
- Agree / change the proposed structure (information architecture) above (PMC / Taskforce)
- Develop new FINOS consistent FDC3 branding
- Logo
- Color Palette
- Update template for fdc3.finos.org and sub groups (new Taskforce)
- Redirect fdc3.org to fdc3.finos.org (todo:OpenFin)
- Update https://www.finos.org/fdc3 to include links to new landing page (Todo:FINOS)
- Merge Mao’s pull requests into the different repo’s, after cleaning up the template and syncing links (todo: Mao + WG group leads)
- Update intro docs (landing page on fdc3.finos.org ) (new Taskforce)
Questions
- Press releases - where do they go?
- Reference implementations / example implementations - where do we link/publish ?