reactivex / rxjs-docs Goto Github PK

Add docs for operator race under group combination

Below is minimum details needed

• name
• operatorType
• signature
• parameters
• short description
• Technical description
• Visual example (Marble diagram)
• Real world example (Non-framework)
• Related Operators

Add docs for operator startWith under group combination

Below is minimum details needed

• name
• operatorType
• signature
• parameters
• short description
• Technical description
• Visual example (Marble diagram)
• Real world example (Non-framework)
• Related Operators

Add docs for operator pairwise under group combination

Below is minimum details needed

• name
• operatorType
• signature
• parameters
• short description
• Technical description
• Visual example (Marble diagram)
• Real world example (Non-framework)
• Related Operators

Add docs for operator concat under group combinational

Below is minimum details needed

• name
• operatorType
• signature
• parameters
• short description
• Technical description
• Visual example (Marble diagram)
• Real world example (Non-framework)
• Related Operators

Angular Material has deprecated md prefix and mat has to be used. Since our package versions are not locked, the current app compilation fails.

Examples of these would be Redux Observable

https://github.com/emberjs/core-notes - chatting with @mattpodwysocki and @benlesh about a repo for all core notes in the reactivex project, not just the docs. also, this would be good for the rxjs core notes.

[ ] Design page for approval
[ ] Core team
[ ] Learning team

Take TS files and convert them into ASTs.
Traverse ASTs to extract out documentation.

Add docs for operator defaultIfEmpty under group conditional

Below is minimum details needed

• name
• operatorType
• signature
• parameters
• short description
• Technical description
• Visual example (Marble diagram)
• Real world example (Non-framework)
• Related Operators

Created based on suggestion in #12 for visualization

[ ] Get approval for format of page
[ ] Design layout of page
[ ] Collect set of companies using RxJS
[ ] Create the ability for people to submit their company
[ ] Create the ability for approvals (is this just submitting a PR or should it be a form?
[ ] Finish creating the page!

Hi everyone!

Here is an update -

• If you have emailed me ([email protected]) about your desire to contribute, I have you on a list and will add you to meetings, etc. If you have not, then I have no way of communicating with you effectively. :)

TODO

• This repo was created (woot!)
• Initial Angular site setup for the RxJS docs
• Brian Troncone will be adding operator descriptions and working on the operators component based off of his already awesome work.
• Ashwin creating issues on the RxJS repo for contributing to these docs and the action items needed before October 16th.
• On October 16th, we will have a kick off meeting that all who have emailed me will be invited to to get things going!
• After that, yolo! :)

Hey all! Say hi if you're interested in contributing! :) Happy to help you get involved! :) Feel free to email me anytime too [email protected]

I've been thinking about this and I actually like the way Vue does this best.

Check out the screenshot.

I'm separating this topic out of #29, cause this is most fundamental thing need to be set before actual work and most important thing for daily work as well.

#29 includes good initial ideas to discuss out

organizing source of traslated document

• put under current repo
• separate repo for each translation
• convert current one into monorepo?

type of source we'll use

• this depends on what tools we'll use

translation pipeline management tools

• crowdin (https://crowdin.com/)
• smartling (https://www.smartling.com/) free edition
• weblate (https://weblate.org/)
• pontoon (https://pontoon.mozilla.org/)
• gitlocalize (https://gitlocalize.com/)
• transifex (https://www.transifex.com/)
• just manually do everything

contributor process

• also depends on what tools we'll use
  Main q: should we encourage any contributor works with githunb's PR flow / or better to make it happen even without knowning git / PR process?

We would like to introduce continuous integration for few purposes. As an initial step, it may need to include

• lint
• build
• test

mostly lint / build should be identical to what current RxJS repo does. For further we'd like to enable bot as well to check commit messages and etcs but that's separate story. (Personally, I'd like to have bot captures screenshot for PR and post it)

Add docs for operator forkJoin under group combination

Below is minimum details needed

• name
• operatorType
• signature
• parameters
• short description
• Technical description
• Visual example (Marble diagram)
• Real world example (Non-framework)
• Related Operators

Add docs for operator zip under group combination

Below is minimum details needed

• name
• operatorType
• signature
• parameters
• short description
• Technical description
• Visual example (Marble diagram)
• Real world example (Non-framework)
• Related Operators

@manekinekko maybe you can help with this!

A feature to search the documentation site to quickly search and navigate to the desired section

anyone up for setting up lint / prettier, etcs for consistent codes? except prettier it's available in RxJS repo already so copy-paste would be sufficient.

Add docs for operator mergeAll under group combination

Below is minimum details needed

• name
• operatorType
• signature
• parameters
• short description
• Technical description
• Visual example (Marble diagram)
• Real world example (Non-framework)
• Related Operators

Configure the application for lazy loading.

When the page loads, a keyboard user has to tab through the entire menu before they can navigate through the main page.

Ideas:

• Add a link to the top of the menu to skip to main page content
• When page loads, focus on the main page, but allow a user to ctrl-tab or cmd-tab backward to access menu.

https://webaim.org/techniques/skipnav/

@feloy ^^

Have at it all - feel free to suggest ideas and let's get something going.

Add docs for operator withLatestFrom under group combination

Below is minimum details needed

• name
• operatorType
• signature
• parameters
• short description
• Technical description
• Visual example (Marble diagram)
• Real world example (Non-framework)
• Related Operators

Have at it all - feel free to suggest ideas and let's get something going.

A page with a list of good RxJS content.

This can be:

• Blog posts

• Videos

• Articles

• Gists

• Stack Overflow

• Etc

• Content does need to be approved by a core team member before being added to make sure we are not sharing anti-patterns, and all links we provide abide by CoC.

• No direct links to paid content.

We can have visualization of the Observables, something like RxViz for an interactive playground instead of putting just images for the Marble Diagrams

RxViz is built in ReactJS, maybe we could port it into Angular2.

Similar projects

• RxViz
• RxMarbles

Open to bikeshedding here.

Add docs for operator concatAll under group combination

Below is minimum details needed

• name
• operatorType
• signature
• parameters
• short description
• Technical description
• Visual example (Marble diagram)
• Real world example (Non-framework)
• Related Operators

RxJS core uses conventional commit for auto-changelog-generate (https://github.com/ReactiveX/rxjs/blob/master/package.json#L84) maybe worth to follow same practices by having git hooks / ci validation. Just opinion to discuss.

Hi, @benlesh . Glad to know the plan for the new docs.
Does have any time plan for now? If has, please let me know 😄 , thx.

Have at it all - feel free to suggest ideas and let's get something going.

Well, ours kind of sucks rn. Open to suggestions.

I'll keep a running list of the learning team meeting notes here.

October 16, 2017 - https://github.com/ReactiveX/rxjs-core-notes/blob/master/rxjs-docs/2017-10/october-16.md

👍

OMG @kwonoj !!!!!!!

I couldn't figure out how to navigate beyond the first JSBin to continue onto the rest of the page. Is there a keyboard shortcut for skipping it, or getting out of it once you've tabbed into the JSBin?
https://webaim.org/techniques/skipnav/

We need to take each individual operator and create issues for these things. Feel free to have at it.
Example: You can create 60 issues for Real World Examples for each individual operator and I would love you forever.

• Real world examples
• Examples in other frameworks
• Visual example
• Architectural use case
• Descriptions
• Use cases
• Edit here interface to allow people to contribute easily.
• Check out this list https://github.com/ReactiveX/rxjs/blob/master/doc/operator-creation.md#submitting-a-pr-for-an-operator
• Another short list of things for each operator: ReactiveX/rxjs#2208 (comment)

Add docs for operator every under group conditional

Below is minimum details needed

• name
• operatorType
• signature
• parameters
• short description
• Technical description
• Visual example (Marble diagram)
• Real world example (Non-framework)
• Related Operators

Add docs for operator merge under group combination

Below is minimum details needed

• name
• operatorType
• signature
• parameters
• short description
• Technical description
• Visual example (Marble diagram)
• Real world example (Non-framework)
• Related Operators

Would love to have this someplace - not sure where this content should be yet. If anyone has suggestions of what content to link to, would be so great to bikeshed here.