Skip to content

Update Federation docs#2982

Merged
smatting merged 1 commit intodevelopfrom
FS-1220-update-federation-docs-2
Jan 12, 2023
Merged

Update Federation docs#2982
smatting merged 1 commit intodevelopfrom
FS-1220-update-federation-docs-2

Conversation

@smatting
Copy link
Contributor

@smatting smatting commented Jan 12, 2023

This PR updates the documentation of Federation

  • Update swimlane figure of federation auth flow for readability
  • Add swimlanes that illustrates the 3 federation api layers
  • Inline the glossary
  • Remove the development roadmap. It's documented elsewhere more accurately
  • Complete API rpc list
  • Add section about ownership
  • Remove / Upate a few "As of .." notes
  • lots of small improvements

@smatting smatting temporarily deployed to cachix January 12, 2023 16:33 — with GitHub Actions Inactive
@smatting smatting temporarily deployed to cachix January 12, 2023 16:33 — with GitHub Actions Inactive
@zebot zebot added the ok-to-test Approved for running tests in CI, overrides not-ok-to-test if both labels exist label Jan 12, 2023
@smatting smatting marked this pull request as ready for review January 12, 2023 16:40
@smatting smatting merged commit 4bfc91a into develop Jan 12, 2023
@smatting smatting deleted the FS-1220-update-federation-docs-2 branch January 12, 2023 16:41
Copy link
Contributor

@pcapriotti pcapriotti left a comment

Choose a reason for hiding this comment

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

I've had a cursory look. Looks good to me. Minor comments below.

As a general note, I would personally avoid contractions and overly informal style in such a document. But that's not really specific to this change.

@pcapriotti
Copy link
Contributor

Ah, sorry, I hadn't realised this was already merged.

@smatting
Copy link
Contributor Author

@pcapriotti Thank you for the review! #2984

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ok-to-test Approved for running tests in CI, overrides not-ok-to-test if both labels exist

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

Comments