Phoenix: Update Phoenix website

Created on 8 Jan 2016  路  34Comments  路  Source: phoenixframework/phoenix

We need to:

  • [x] List companies using Phoenix in production
  • [x] Promote the book
  • [x] Overhaul the guides

Most helpful comment

We are working on the 1.3 guides now and will release them soon with 1.3 final. Hang tight!

All 34 comments

@josevalim We use Phoenix at Heroic Labs. :smile:

Not sure if it's helpful or not but I've been maintaining a list of companies using Elixir (and Phoenix) in production: https://github.com/doomspork/elixir-companies

That is extremely helpful. :)

On the top right the widget where you currently see the latest 1.1.2 release, that thing does nothing :) I would expect after selecting a version I will get release notes or at least to the github release page? Selecting "view all versions" brings me to an overview, where every click on a link brings me back to the home page.
Tested with Chrome 47

... oh and I looked into the source and saw some spooky ng- prefixed classnames and some commented js code ^^ _ishowmyselfout_

readme hosts our guides and it sounds like that feature is broken on their end so there isn't anything for us to fix in this case. Thanks!

Phoenix drives our Twilio integrated phone system at Cage Data. Handles voicemails and conference calling.

@josevalim I'd love to contribute to the guides. Be it working on a section/expanding it or simply proofreading in general. I commented on another issue as well -- I'd love to contribute a bit. I've been lucky enough to be working almost exclusively in Elixir/Phoenix the last few months and I'm starting to feel comfortable enough to hopefully be useful :smile:

@ybur-yug that's exciting to hear! We really need someone to help us with the guides, there are a lot of issues open and contributions but we haven't had the time to maintain it. The repository is here: https://github.com/phoenixframework/phoenix_guides

Let us know if you have any questions!

@josevalim Awesome, I'll poke around the issues and get a feel for where I could give the most useful help.

I don't think it's very important, but there's a typo on the blog page of the Phoenix website. Just take out the "i" in: mix phoeinix.server

@19smitgr Thanks for raising it. Should be fixed now.

@19smitgr and @Gazler I had warned about that typo in the Phoenix Guides repo because there was the same typo in another page (I think Lance took care of it). Maybe it's a recurring problem in several pages?

@Gazler I don't think it is because searching url:phoenixframework.org "phoeinix" on Google doesn't return anything other than what he just fixed.

Overhaul the guides

what sort of help do you guys need with this one? I happen to love writing documentation and building UI design ;)

We mainly will focus on updating the guides to include missing pieces around features that materialized after the guides were written 鈥撀爂enerators, more in depth channel usage, presence, etc. We will also be introducing changes to generators with Phoenix 1.3, so hang tight for now, but I appreciate the willingness to help!

@chrismccord one of the plans was also to eventually move to ExDoc guides too. :)

@josevalim @chrismccord https://github.com/phoenixframework/phoenix_guides/issues/391 is the related issue.

I, as someone learning Phoenix, found it extremely helpful to get to know about the way the abstractions work. It was confusing for me to get told "this is the view, it handles preparations for rendering", but not what a view actually _is_. It was very insightful, when @josevalim said in a podcast that it's just a module exposing a render function. That makes working with it so much easier. Knowing not only the abstract ideas, but the actual rules and properties of a view module. Such information should be easier to get than stumbling upon it in a podcast.

I hope you get what I am trying to say. I would be exited to find such information in the future guides.

EDIT: I just started reading Programming Phoenix and it has all I had wished for.

How do I contribute to documentation? Write an issue? Create a pull request? I'm just starting out with phoenix, and there's no better time to correct the small stuff.

In this case, the directory structures seem out of date in the Adding Pages section.

Doing a Google search for phoenix getting started gives this ancient getting started page from x0.10.0 (March 2015). As that's a super common search term for beginners, it should provide useful results.

Please in the official guides consider using syntax highlighting on example code like hexdocs.pm

I just stumbled upon this issue after having opened https://github.com/phoenixframework/phoenix_guides/issues/663 a few days ago. Many of my frustrations are shared by multiple people in this [now old] issue, including the old 0.10.0 docs, readme.io annoyances, etc :)

@josevalim @chrismccord I also note the guides haven't been committed to almost three months; Do you need another maintainer to help...? I opened the issue to ask about these weirdnesses but if you literally need someone to sort out said weirdnesses I totally understand and that's a different matter :) How readme.io and website connect with the ex_doc is what's hidden to me right now.

@chrisarcand I believe we are ditching readme.io and moving all the guides to ex_doc. The reasons the guides have been low in commits is because with the work on v1.3.0 we will have to rewrite a good part of the docs to provide the best experience. So there is a lot of work waiting for v1.3.0 to be out.

@josevalim Awesome. Thanks for the clarification!

Site throws debug info / error

Took a look at Diesel (Rust) realized it is too far from SQL for my taste (I like CakePHP3 ORM and Rail's 3+ Arel) wanted to see if Phoenix/Ecto are closer to SQL-'think': Got this error instead:

img_3401
img_3402
img_3403
img_3404

we use Elixir Phoenix at Findmypast

Regarding companies using Elixir, Solaris Bank uses Elixir for its backend. It's a new bank with a modern stack which offers an API powered financial platform . I don't work for them but I used to use their API.

There is a request to add language translations to the site. I would be happy to join the project of translating documentation into different languages.

Translations will have to be put on hold until at least the major overhaul dust settles. Thanks for the interesting in helping out!

Hey everybody!

Big fan of Phoenix + the community on Slack is just so friendly and great. @chrismccord + team you've really made something special here.

Quick question for you all:

Is there a need to update the site to provide documentation for the state of the release candidate? We had a big discussion about contexts and accounts, and although everything isn't hashed out yet - would it make sense to add a little bit about them on the site? I totally get if the site is just meant for the stable build, but it would be nice to have a place to read more about 1.3.x rather than hunt through the blogosphere.

Happy to do so if required!

We are working on the 1.3 guides now and will release them soon with 1.3 final. Hang tight!

@chrismccord just to get an idea, is soon something like in the next few weeks or more the next few months? I do not want to be rude, but we are kicking off a new project and it if we are talking in weeks we might just wait a bit more to start with the final 1.3

I realize I'm late to the party here. I'd love to help update 1.3 guides. where/how can I get involved?

Closing as the site now has its own repo.

Was this page helpful?
0 / 5 - 0 ratings