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

491 formal spec reorg #712

Merged
merged 62 commits into from
May 17, 2022
Merged

491 formal spec reorg #712

merged 62 commits into from
May 17, 2022

Conversation

kriswest
Copy link
Contributor

@kriswest kriswest commented May 13, 2022

resolves #491
resolves #482
resolves #483
resolves #629

Re-organize documentation nav, and restructures main overview/spec articles to improve readability, without changing the content of the standard.

New PR with preview
Original PR was approved by @greyseer256 and @robmoffat

  • [WIP] 491 formal spec reorg #679
    The goal of this work was to raise the quality of the standard's documentation to that of a formal standard, make it more readable/navigable and to bring the governance details up to date and into the microsite.

To that end we have:

  • Refactored the site navigation,
    • introduced a clearly defined formal specification section
    • incorporated the reference materials (that do most of the definition) into the standard (these were only weakly referenced before)
    • Integrated the overview pages into the main specification pages (which are now called overview)
  • Improved the structure of articles
    • Deduplicated content between old overview, spec and reference articles
    • Refactored the new spec documents to improve structure (e.g. separating use-case definitions from implementation details in the API article, integrating use-case and discovery pages into appD overview)
    • Reviewed in-page navigation
  • Introduced abstract pages for standard versions
    • including dates on adoption/release/obsoletion
    • acts as a landing page for 'the standard'
  • Added a roadmap page to track progress on next standard version
  • Created an implementations page
    • not added to nav yet, need to collect details from vendors to populate,
    • determine policy for compliance tagging

Outstanding work (to be completed during 2.0 release):

  • Collect up compliance details across standard and summarize on compliance page

kriswest and others added 30 commits January 26, 2022 15:08
Co-authored-by: Hugh Troeger <troeger.hugh@gmail.com>
Co-authored-by: openfin-johans <98814236+openfin-johans@users.noreply.github.com>
Co-authored-by: openfin-johans <98814236+openfin-johans@users.noreply.github.com>
… past verions, refactors nav and sidebar, first pass at implementations page
…content and correcting structure of document
robmoffat and others added 9 commits May 13, 2022 10:24
Co-authored-by: Kris West <kris@cosaic.io>
Co-authored-by: Kris West <kris@cosaic.io>
Co-authored-by: Kris West <kris@cosaic.io>
Co-authored-by: Kris West <kris@cosaic.io>
Co-authored-by: Kris West <kris@cosaic.io>
Chosen -> Responsible
Creates an FDC3 roadmap page in microsite
@nkolba
Copy link
Contributor

nkolba commented May 16, 2022

@kriswest LGTM

What are thoughts on adding an "open source" tab in the implementations section?

@kriswest
Copy link
Contributor Author

What are thoughts on adding an "open source" tab in the implementations section?

We're continuing the development of the implementations page on PR #714, where @robmoffat has had a go at adding badges (to help expose compliance info, when a testing process is available). As Open-source cuts across/could apply to all the types, would a badge work?

Copy link
Contributor

@mattjamieson mattjamieson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Minor stylistic/consistency suggestions only.

Copy link
Contributor

@RexJaeschke RexJaeschke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well done Kris! I looked at the new organization and the higher-level section content. I reviewed the Issues labelled "formal specification" that I raised, and they appear to have been addressed.

@kriswest kriswest linked an issue May 17, 2022 that may be closed by this pull request
@kriswest kriswest added this to the 2.0 milestone May 17, 2022
@kriswest kriswest linked an issue May 17, 2022 that may be closed by this pull request
kriswest and others added 4 commits May 17, 2022 18:17
Co-authored-by: Matt Jamieson <10372+mattjamieson@users.noreply.github.com>
Co-authored-by: Rex Jaeschke <rex@RexJaeschke.com>
@kriswest
Copy link
Contributor Author

Many thanks @RexJaeschke @greyseer256 @robmoffat @mattjamieson @nkolba for your reviews across this PR and its predecessor, excited to hit the merge button on this one.

@kriswest kriswest merged commit 21e3555 into master May 17, 2022
@kriswest kriswest deleted the 491-formal-spec-reorg branch May 20, 2022 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
6 participants