Skip to content
This repository has been archived by the owner. It is now read-only.

Starting the RxJS docs initiative #4

Closed
ladyleet opened this issue Oct 1, 2017 · 60 comments
Closed

Starting the RxJS docs initiative #4

ladyleet opened this issue Oct 1, 2017 · 60 comments

Comments

@ladyleet
Copy link
Member

@ladyleet ladyleet commented Oct 1, 2017

Hi everyone!

Here is an update -

  • If you have emailed me (tracy@thisdot.co) 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! :)
@ladyleet
Copy link
Member Author

@ladyleet ladyleet commented Oct 1, 2017

@ladyleet
Copy link
Member Author

@ladyleet ladyleet commented Oct 1, 2017

Feel free to comment on this with ideas/suggestions to enhance our docs initiative.

@ladyleet
Copy link
Member Author

@ladyleet ladyleet commented Oct 1, 2017

@rhgeek @tracyalison11 @btroncone feel free to document what you've been doing here or the plan to keep folks in the know of progress!

@feloy
Copy link
Contributor

@feloy feloy commented Oct 1, 2017

It would be interesting to configure server-side rendering, so one can get a static version of the documentation.

@inf3cti0n95
Copy link

@inf3cti0n95 inf3cti0n95 commented Oct 1, 2017

@ladyleet How about A Progressive Web App?

People would be able to browse docs offline :), A Nice read while traveling

@ladyleet
Copy link
Member Author

@ladyleet ladyleet commented Oct 1, 2017

@inf3cti0n95 that sounds like a great idea! optimizing for this and converting the site to that sounds perf.

@ladyleet
Copy link
Member Author

@ladyleet ladyleet commented Oct 1, 2017

@feloy agreed! that would be lovely too! i love these ideas.

@feloy
Copy link
Contributor

@feloy feloy commented Oct 1, 2017

What about creating a personalized Schematics collection so one can easily add a new rxjs operator?

ng generate rx-operator pluck

@ladyleet
Copy link
Member Author

@ladyleet ladyleet commented Oct 1, 2017

@feloy that question will have to be bikeshedded by @benlesh and @kwonoj

@ladyleet ladyleet changed the title Starting the RxJS docs intiative Starting the RxJS docs initiative Oct 1, 2017
@btroncone
Copy link
Collaborator

@btroncone btroncone commented Oct 1, 2017

@inf3cti0n95 I will convert to a PWA in an early PR. 👍🏻 @ladyleet

@ladyleet
Copy link
Member Author

@ladyleet ladyleet commented Oct 1, 2017

@btroncone yeah baby!

@inf3cti0n95
Copy link

@inf3cti0n95 inf3cti0n95 commented Oct 1, 2017

@btroncone I am in for PWA, I'll tag along 😉

@ladyleet
Copy link
Member Author

@ladyleet ladyleet commented Oct 2, 2017

@feloy omg let's do this pls.

@ladyleet
Copy link
Member Author

@ladyleet ladyleet commented Oct 2, 2017

@inf3cti0n95 #5 PWA awesomeness from @btroncone

@ladyleet
Copy link
Member Author

@ladyleet ladyleet commented Oct 2, 2017

just created a bunch of issues for translating the docs.

@KiltedCode
Copy link

@KiltedCode KiltedCode commented Oct 2, 2017

For creating issues related to the operators that need added, we've been compiling a list of what is missing. We'll then be adding issues for each of these, possibly multiple for the different pieces that are needed to fully document each (i.e. description, example...).

Here is the current working list

  • Ajax
    • get
    • post
    • delete
    • put
    • patch
    • getJSON
  • distinctUntilChanged
  • finally
  • forkJoin
  • if
  • let
  • publishBehavior
  • publishLast
  • publishReplay
  • shareReplay
  • skipLast
  • Subject.create
  • Timeinterval
  • timeout
  • timeoutWith
  • timestamp
  • toArray
  • zipAll
  • zipProto

Other Updates Needed

@ladyleet
Copy link
Member Author

@ladyleet ladyleet commented Oct 2, 2017

@RHGeek That's what I'm 🌮 ing about! 🍕 create those issues when you can! :) 🍌 waiting for these docs forever! 💯

@btroncone
Copy link
Collaborator

@btroncone btroncone commented Oct 2, 2017

Any thoughts or ideas on the best way to maintain operator information? One of the things I like about GitBook is how easy it is for others to contribute by modifying the corresponding markdown file. How can we keep this simple for contributors to add or extend explanations and examples in the new docs?

@ladyleet
Copy link
Member Author

@ladyleet ladyleet commented Oct 2, 2017

Hey @btroncone just to get things going - @benlesh and I talked about this - why don't we just create a service with the array of data that folks can update + abstract away the array by creating methods to call the data so we can change it later. Thoughts?

@btroncone
Copy link
Collaborator

@btroncone btroncone commented Oct 2, 2017

@ladyleet That works for me. 👍

@fredrik-lundin
Copy link
Contributor

@fredrik-lundin fredrik-lundin commented Oct 2, 2017

I'd love to contribute when you have more concrete issues ready to be worked on :)

@ladyleet
Copy link
Member Author

@ladyleet ladyleet commented Oct 2, 2017

@fredrik-lundin actually Issue #10 and Issue #14 could be worked on now! :) If you're up for it!

@feloy
Copy link
Contributor

@feloy feloy commented Oct 2, 2017

@ladyleet i've made 2 proposals yesterday about SSR and Schematics. But I'm not sure of the order of your replies...

@ladyleet
Copy link
Member Author

@ladyleet ladyleet commented Oct 2, 2017

@feloy both sound like great ideas. :) feel free to take and implement! :) i esp love the idea of schematics.

@ladyleet
Copy link
Member Author

@ladyleet ladyleet commented Oct 2, 2017

@RHGeek while y'all are doing that do you want to take the other issues related to translation? and generating issues for each individual operator there?

@feloy
Copy link
Contributor

@feloy feloy commented Oct 2, 2017

@ladyleet when I work on SSR, I would be happy to work on a travisCI (or equivalent) config to automatically generate indexable pages and deploy them on a website.
Have you already chosen a platform to deploy the website to?

@ladyleet
Copy link
Member Author

@ladyleet ladyleet commented Oct 2, 2017

@feloy not yet :( @benlesh? Thoughts?

@kwonoj
Copy link
Member

@kwonoj kwonoj commented Oct 2, 2017

@ladyleet @feloy I can enable travis, but not sure about auto-deploy at this moment. probably better to discuss separately (build / test on travis first, deploy as separate topic).

@btroncone
Copy link
Collaborator

@btroncone btroncone commented Oct 4, 2017

Just a quick update, I'm working on operator UI right now. I hope to have a first version available with at least a sample of operators to poke around with by the end of this weekend or early next week. I'll post as soon as it's available. 👍

@ladyleet
Copy link
Member Author

@ladyleet ladyleet commented Oct 5, 2017

@btroncone awessome!

@xtianjohns
Copy link

@xtianjohns xtianjohns commented Oct 5, 2017

Hey @ladyleet do you know how/if we currently track docs usage? Is there any interest in tracking which operators get the most traffic, or monitoring how users will interact with the new docs?

@ladyleet
Copy link
Member Author

@ladyleet ladyleet commented Oct 5, 2017

@xtianjohns sure that'd be so cool!

@KiltedCode
Copy link

@KiltedCode KiltedCode commented Oct 8, 2017

@ladyleet sorry for the delay in getting back, but yeah, we can add translation related issues to go with all the new operators. I will search to see what issues are created for particular languages (I've seen you tag me in some), but we can also identify any more that we want to proactively.

@ladyleet
Copy link
Member Author

@ladyleet ladyleet commented Oct 9, 2017

translations - we are bikeshedding here #29

@KiltedCode
Copy link

@KiltedCode KiltedCode commented Oct 16, 2017

I've added 3 issues as examples for how all the rest from the list can be added. Please let me know if these look ok, before the rest then get added. These would be the three "pieces" needed to complete the documentation for that operator.

ReactiveX/rxjs#2939
ReactiveX/rxjs#2940
ReactiveX/rxjs#2941

@ladyleet
Copy link
Member Author

@ladyleet ladyleet commented Oct 16, 2017

@rhgeek this is perfect thanks! :)

@KiltedCode
Copy link

@KiltedCode KiltedCode commented Oct 16, 2017

@ladyleet Ok, then I'll look to use the format to get the rest entered in with Tracy.

@kwonoj
Copy link
Member

@kwonoj kwonoj commented Oct 16, 2017

Maybe better to create single issue for each operator, then list todo as checkboxes? (though not sure which'll be better, concerning numbers of issue might get exploded)

@ladyleet
Copy link
Member Author

@ladyleet ladyleet commented Oct 16, 2017

@kwonoj yeah but closing issues just feels so good and allows easy individual contributors to work through things easier IMO.

@kwonoj
Copy link
Member

@kwonoj kwonoj commented Oct 16, 2017

@ladyleet yup, that's reason I'm not suggesting to do so at this moment. Have to see for few cycles to make decision.

@KiltedCode
Copy link

@KiltedCode KiltedCode commented Oct 16, 2017

@kwonoj @ladyleet Yeah, that was the general idea, creating them separate to make it easier for people to contribute to a piece of the documentation. If they only feel comfortable with writing descriptions and maybe not examples, they can close that out and it might be less intimidating to contribute then if all 3 pieces were in one issue. If it does seem to be too much, we can consolidate them as well.

@GustavoCostaW
Copy link

@GustavoCostaW GustavoCostaW commented Oct 16, 2017

The status in our meeting about the operators visualization, we have three options:

  • rxviz
  • rxmarbles
  • rxfiddle

Which will we use?

@arat3091
Copy link

@arat3091 arat3091 commented Oct 16, 2017

Guys i have a question. Cant we create the branch on github which i can checkout and do my work on it and then later create the pull request to merge to master. I see i do not have the permission to create the branch . How should we go about it ?

@xtianjohns
Copy link

@xtianjohns xtianjohns commented Oct 16, 2017

Hey @arat3091, you won't be able to create a branch in this repository. However, you can fork this repository and create a branch in your fork. When you feel like your work is ready, you can submit your pull request from your fork into this repo. Make sense?

@crunchie84
Copy link

@crunchie84 crunchie84 commented Oct 18, 2017

Shout out to @hermanbanken - would RxFiddle be a match to render the operator visualisations?

@rgbkrk
Copy link

@rgbkrk rgbkrk commented Nov 15, 2017

Well this is awesome, thanks for kicking this off!

@ladyleet
Copy link
Member Author

@ladyleet ladyleet commented Nov 15, 2017

Thx Kyle!

@michahell
Copy link

@michahell michahell commented Jan 25, 2018

thanks guys!

@benlesh
Copy link
Member

@benlesh benlesh commented Jan 26, 2018

@ladyleet how are we doing with these bullet points?

@jonathanconway
Copy link

@jonathanconway jonathanconway commented Feb 14, 2018

Hey all. I'm keen to contribute. Thinking of documenting publishReplay. Shall I create an issue?

@ladyleet
Copy link
Member Author

@ladyleet ladyleet commented Feb 14, 2018

@jonathanconway yes please do!

@ladyleet
Copy link
Member Author

@ladyleet ladyleet commented Feb 14, 2018

Closing this issue out as we have kicked off the docs! If anyone in this thread still needs help contributing you can always email me at tracy@thisdot.co and I'm happy to be of service. Or, email me so I can add you to our slack channel!

@ladyleet ladyleet closed this Feb 14, 2018
@ladyleet
Copy link
Member Author

@ladyleet ladyleet commented Feb 14, 2018

@benlesh thx ben for pinging me to close this!

@cschomer
Copy link
Contributor

@cschomer cschomer commented Mar 4, 2018

Hi was just wondering if StackBlitz was in talks for being used and or perhaps dynamic marbles like below (granted the marbles need an auto expanding line and perhaps using svg or canvas might be better) or is there a site that already has this?
SB Code and Demo
Interval Observable Example Site

@ladyleet
Copy link
Member Author

@ladyleet ladyleet commented Mar 4, 2018

@cschomer yes on stackblitz!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet