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

Update website with project pages and documentation #8

Closed
WyriHaximus opened this issue Aug 17, 2015 · 26 comments
Closed

Update website with project pages and documentation #8

WyriHaximus opened this issue Aug 17, 2015 · 26 comments

Comments

@WyriHaximus
Copy link
Member

One of the criticisms made against reactphp is the lack of documentation. Currently the website shows a small example on making a webserver while there is a lot more to the project. My suggestion is to add project pages for each component on the website and add simple getting started examples. This to make the learning curve easier.

@jsor
Copy link
Member

jsor commented Aug 17, 2015

Maybe the website can be converted to Github Pages with a custom domain for easier deployment

@WyriHaximus
Copy link
Member Author

Sounds good to me 👍

@cboden
Copy link
Member

cboden commented Aug 17, 2015

+1

@wfleurant
Copy link

indexing each unique project? I know what you mean but I think the current site is nice because it grouped projects.. I would even argue that reviewing the current list for updates/creates shouldn't be overlooked if/when it goes to gh-pages.

  1. Async Utilities
  2. Callback Heaven
  3. DNode Bindings
  4. Domain Checker
  5. Drone Remote Control
  6. Partial Application
  7. Real Time Animated Gif
  8. Redis Client
  9. Samples Apps
  10. STOMP Bindings
  11. WebSocket Server
  12. Whois Client
  13. ZeroMQ Bindings

@WyriHaximus
Copy link
Member Author

A small page + some introduction examples for each project under the reactphp namespace:

  • react/async
  • react/cache
  • react/child-process
  • react/datagram
  • react/dns
  • react/event-loop
  • react/filesystem
  • react/http
  • react/http-client
  • react/promise
  • react/promise-timer
  • react/socket
  • react/socket-client
  • react/stomp
  • react/stream
  • react/zmq

Yes that is a lot of pages but if we have one place for new users to start and reference the project as a whole is more accessible. The current frontpage would stay the same the idea is to add more pages.

@jsor
Copy link
Member

jsor commented Aug 18, 2015

👍
This could probably be similar to http://thephpleague.com

@clue
Copy link
Member

clue commented Sep 7, 2015

One of the criticisms made against reactphp is the lack of documentation.

Big 👍 for updating this, as I share the view that the current website makes the project look quite dead.

May be the website can be converted to Github Pages with a custom domain for easier deployment

Big 👍 for making contributing to this as easy as possible and trying to eliminate any barriers.

A small page + some introduction examples for each project under the reactphp namespace

👎 While this sounds like a good idea to me, I expect this to take a non-trivial amount of work to set up and maintain. Instead, I would vote to keep this as simple as possible and reference the individual project pages.

This could probably be similar to http://thephpleague.com

👍 IMHO this is quite spot on and adds no unnecessary duplication (single source of truth). After all, even the simple README.md for each component is often slacking behind, so I would rather invest time there.

@jsor
Copy link
Member

jsor commented Jul 19, 2016

I took a few minutes to do a quick mockup: http://sorgalla.com/reactphp.github.io/
Please do a quick 👍 or 👎 (I'm not a designer, so don't be too harsh 😊) so i know if i should continue or trash the whole thing.

Please don't comment on the content, it's just some copy & paste for now.

@WyriHaximus
Copy link
Member Author

@jsor looking good! 👍 I have some ideas, will try and make a PR tonight

@jsor
Copy link
Member

jsor commented Jul 19, 2016

Great! In case anyone is wondering, the repo is here: https://github.com/jsor/reactphp.github.io

@cboden
Copy link
Member

cboden commented Jul 19, 2016

Looking good. I'd suggest taking the FAQ point about threading out though :)

@cboden
Copy link
Member

cboden commented Jul 19, 2016

Please don't comment on the content, it's just some copy & paste for now

My bad. I should RTFM before replying. 🙃

@WyriHaximus
Copy link
Member Author

Mine are content and design wise, but more as in adding content and I'll wrap them in different PR's while adding a screenshot with preview

@jsor
Copy link
Member

jsor commented Jul 19, 2016

Updates: Removed the FAQ section, added footer and code example.

@WyriHaximus
Copy link
Member Author

On mobile the components look off.

screenshot_20160719-190141

@WyriHaximus
Copy link
Member Author

WyriHaximus commented Jul 19, 2016

By the way I do like the implied event loop in the logo 👍

@jsor
Copy link
Member

jsor commented Jul 19, 2016

@WyriHaximus Yes, as i said, this is just a quick mockup and nothing is fully worked out 😃

It's only about the general direction it is going, like the logo, colors, typography. If noone is having strong objections, i'm going to work it out.

Regarding the logo: the R stands obviously for React, the red line is both a P (for PHP) and a symbol for the loop.

@WyriHaximus
Copy link
Member Author

@jsor hah sorry I'm jumping the gun a bit 😄 .

Very well done! I have no objections to the style, colours and overall feel.

@clue
Copy link
Member

clue commented Jul 19, 2016

I'm a big fan of your mockup and I think this is very good first step and very much worth working on 👍

I also do like your suggested logo (and its reasoning), but I'm not sure this is something we should change prematurely, so I'm having to 👎 this for now and would love to discuss this in a separate issue first.

@jsor jsor mentioned this issue Jul 20, 2016
@jsor
Copy link
Member

jsor commented Jul 20, 2016

@clue Logo RFC is here: #10

@jsor
Copy link
Member

jsor commented Jul 21, 2016

Development now happens in https://github.com/reactphp/reactphp.github.io. Preview at https://reactphp.github.io.

@clue
Copy link
Member

clue commented Aug 20, 2016

Thanks @jsor! 🎉

Unfortunately, we now have two repos housing our website :)

A) Can we merge the two repos into one?

B) I guess we can mark this repo as deprecated and redirect people to the new repo instead?
We should probably file a new ticket there to keep track of what still needs to be done?

I think open A) is more appealing as it causes less confusion. What do you think?

@WyriHaximus
Copy link
Member Author

A) 👍
B) 👎

@davidwdan
Copy link

👍 This looks amazing. However, I would like to see a dedicated page with documentation and examples for each component. Bouncing people out to github for docs, creates a confusing and inconsistent user experience.

@WyriHaximus
Copy link
Member Author

Absolutely, but I think we should focus on the logo and colours first.

@WyriHaximus
Copy link
Member Author

WyriHaximus commented May 8, 2017

We've just launch the new website via #11 http://reactphp.org/ so closing this

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

No branches or pull requests

6 participants