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

[CHORE] The walkthrough appears to be outdated (v1.6.14) #112

Closed
11 tasks done
LuchoTurtle opened this issue Oct 12, 2022 · 3 comments · Fixed by #113
Closed
11 tasks done

[CHORE] The walkthrough appears to be outdated (v1.6.14) #112

LuchoTurtle opened this issue Oct 12, 2022 · 3 comments · Fixed by #113
Assignees
Labels

Comments

@LuchoTurtle
Copy link
Member

LuchoTurtle commented Oct 12, 2022

As of the time of writing, Phoenix's latest version is 1.6.14 (with 1.7 apparently coming very soon 🤩 ).
This tutorial is great and works perfectly if I clone and run it.

However, when I try to build a new Phoenix app from scratch and follow this tutorial,
some information appears to be outdated.

Here are a few examples:

  • The boostrapped project with the newest version appears to have more files in some folders, namely lib\templates\layout.
  • Updating the layout template on app.html.eex does not make sense now, since the information is on root.html.eex.
  • Tests do not pass after "correcting" in page_controller_test.exs.

This is a snowball effect and for anyone that is new, they expect this tutorial to "Just WorkTM".
No doubt it does with v.1.6.11, though!

I'll try to update the tutorial to the latest version and the README file accordingly to the best of my abilities 😄 ...

Todo

  • clone the repo to localhost ⬇️
  • make a reference copy of the repo e.g. cp phoenix-chat-example phoenix-chat-example_OLD so that you can have one open while editing the other and not have to switch between branches. ✌️

Note: this is where having that second or third screen comes into play. 💻 + 🖥️ + 🖥️ 💭

  • Create a new branch e.g. rewrite-phoenix-v1.6.14-issue#112 (snappy name, right? 😜)
    • git push the new branch to GitHub ASAP so that you can see if CI (GitHub Actions) continues to pass.
  • Re-create the app from scratch following the instructions in the README.md as much as possible. 🧑‍💻
  • Update the sections that require it. 🆙
  • Preserve the Testing and any other sections that are still relevant. 🥇
  • Create a PR and assign it to me for review. 🙏
@LuchoTurtle LuchoTurtle added enhancement New feature or request chore labels Oct 12, 2022
@LuchoTurtle LuchoTurtle self-assigned this Oct 12, 2022
@nelsonic
Copy link
Member

@LuchoTurtle thank you very much for opening this issue. 🎉
I periodically go through the tutorials with the latest version of Phoenix and make adjustments. 📝
But I haven't done it properly for a few versions ... ⏳ 🙄

Sounds like we need to treat the existing code as a reference
and essentially re-do it from scratch with a full mix phx.new ...

That being the case, I've updated the OP to reflect the work that needs to be done. 💭

@LuchoTurtle
Copy link
Member Author

@nelsonic consider changing the description to 💬 A Step-by-Step Beginners Tutorial for Building, Testing & Deploying a Chat app in Phoenix 1.6.14🚀 😉

@nelsonic
Copy link
Member

@LuchoTurtle you should have access to make the update. if not, please LMK. 👍

@nelsonic nelsonic unpinned this issue Dec 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants