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

docs: (WIP) Getting Started Documentation Page #29

Merged
merged 4 commits into from May 9, 2021

Conversation

viglucci
Copy link
Member

@viglucci viglucci commented Feb 23, 2021

Work In Progress.

Progress on adding a "Getting Started" documentation page, following a rough outline (open to feedback/change):

  • TOC
  • Getting Started vanilla RSocket
    • Dependencies (JS, JAVA, CPP, Kotlin, Go, Rust, Python, Ruby)
    • Connector example (WS) + Server Example (WS) with some minimalist requestResponse
    • Working with Payload (data | metadata)
    • Composite Metadata
    • Routing your request
    • Tracing
    • Auth Metadata
  • Getting Started with RSocket RPC
  • Setup dependencies
  • Code generation
  • Reactive API
    • Flowable
    • Single
    • Project Reactor
  • Tutorials (in Action)
    • Chat App (Authentication, Routing, RPC)
    • Frontend (React/Angular/etc.)

Live preview: https://deploy-preview-29--rsocket.netlify.app/docs/getting-started


Open question for @OlegDokuka and other rsocket-java contributors concerning rsocket-java examples for constructing an RSocketConnector:

Some examples demonstrate the .connectWith(transport) API and others demmonstrate RSocketClient.from(source). Do we prefer one of the other for code examples?

WebsocketClientTransport ws = WebsocketClientTransport.create(
  URI.create("ws://rsocket-demo.herokuapp.com/ws"));

RSocket clientRSocket = RSocketConnector
  .connectWith(ws)
  .block();

compared to:

Mono<RSocket> source =  RSocketConnector.create()
 .metadataMimeType("message/x.rsocket.composite-metadata.v0")
 .dataMimeType("application/json")
 .connect(TcpClientTransport.create("localhost", 7000));

RSocket clientRSocket = RSocketClient.from(source);

@viglucci viglucci changed the title (WIP) Getting Started Documentation Page docs: (WIP) Getting Started Documentation Page Feb 23, 2021
This was referenced Mar 2, 2021
flyinprogrammer added a commit that referenced this pull request Mar 2, 2021
missed moving svgs in rebase
@viglucci viglucci merged commit 1a3a31c into master May 9, 2021
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.

None yet

1 participant