getting-started-with-phoenix docs #504

chrishop · 2023-02-07T09:26:42Z

docs: replaced test explaination with LiveView example

Update: 13/02/2023

addressed comments to previous draft
added section introducing code interface
added section integrating the Post resource with a LiveView

docs: 3rd draft of getting-started-with-ash-and-phoenix

Update: 09/02/2023

renamed from getting-started-with-phoenix -> getting-started-with-ash-and-phoenix
many minor changes in phrasing, formatting.
moved text & code block around in their section
only show bash command, not the following logs
merged API and registry section together
extra section showing how to call resource from phoenix

docs: did a rework of initial get-started-with-phoenix draft

Update: 08/02/2023

I was copying the helpdesk example from the pure ash getting started article.
But there was too much extra content which made the guide very long.
Instead I decided the make the resource very minimal, included lots of
information about how to get ash up and running with phoenix and ash postgres.

I'm very welcome to recieve feedback on what I've done so far, I want it to be
as good as it can be.

documentation/tutorials/get-started-with-phoenix.md

- Edited AshPostgres.Repo vs Ecto.Repo comment - Cut 'If using Phoenix 1.7 or higher' section, its only neccessary for ash authentication

- Phoenix is now all uppercase - Ash is now all uppercase - moved `mix ecto.create` warning to before you run the command

I was copying the helpdesk example from the pure ash getting started article. But there was too much extra content which made the guide very long. Instead I decided the make the resource very minimal, included lots of information about how to get ash up and running with phoenix and ash postgres. I'm very welcome to recieve feedback on what I've done so far, I want it to be as good as it can be.

…guide in ash-hq: ash-project/ash#504

documentation/tutorials/get-started-with-phoenix.md

- renamed from getting-started-with-phoenix -> getting-started-with-ash-and-phoenix - many minor changes in phrasing, formatting. - moved text & code block around in their section - only show bash command, not the following logs - merged API and registry section together - extra section showing how to call resource from phoenix

documentation/tutorials/get-started-with-ash-and-phoenix.md

mostly typos grammar and rewordings

documentation/tutorials/get-started-with-ash-and-phoenix.md

sevenseacat · 2023-02-14T07:02:33Z

documentation/tutorials/get-started-with-ash-and-phoenix.md

+config :ash, :use_all_identities_in_manage_relationship?, false
+
+config :my_ash_phoenix_app,
+  ash_apis: [MyAshPhoenixApp.Blog]


Does this part replace the config :my_app, ecto_repos: [MyApp.Repo] line? Or should be in addition to it?

It doesn't replace ecto_repos it is in addition to it. At the top of the code block I say: "Add this to your config:"

documentation/tutorials/get-started-with-ash-and-phoenix.md

… access liveview

chrishop · 2023-02-14T07:53:46Z

Closed in favour of: ash-project/ash_phoenix#70, it fits better in that project.

@sevenseacat

* docs: derived from ash-project/ash#504 * docs: addressed @sevenseacat comments * docs: added comment about usage

wip: docgetting-started-with-phoenix docs

5bebd77

zachdaniel reviewed Feb 7, 2023

View reviewed changes

documentation/tutorials/get-started-with-phoenix.md Outdated Show resolved Hide resolved

zachdaniel reviewed Feb 7, 2023

View reviewed changes

documentation/tutorials/get-started-with-phoenix.md Outdated Show resolved Hide resolved

zachdaniel reviewed Feb 7, 2023

View reviewed changes

documentation/tutorials/get-started-with-phoenix.md Outdated Show resolved Hide resolved

martinstannard reviewed Feb 7, 2023

View reviewed changes

documentation/tutorials/get-started-with-phoenix.md Outdated Show resolved Hide resolved

martinstannard reviewed Feb 7, 2023

View reviewed changes

documentation/tutorials/get-started-with-phoenix.md Outdated Show resolved Hide resolved

martinstannard reviewed Feb 7, 2023

View reviewed changes

documentation/tutorials/get-started-with-phoenix.md Outdated Show resolved Hide resolved

martinstannard reviewed Feb 7, 2023

View reviewed changes

documentation/tutorials/get-started-with-phoenix.md Outdated Show resolved Hide resolved

chrishop added 3 commits February 8, 2023 08:10

docs: addressed zach's comments

64bf340

- Edited AshPostgres.Repo vs Ecto.Repo comment - Cut 'If using Phoenix 1.7 or higher' section, its only neccessary for ash authentication

docs: addressed martins comments

fb62b92

- Phoenix is now all uppercase - Ash is now all uppercase - moved `mix ecto.create` warning to before you run the command

chrishop changed the title ~~wip: docgetting-started-with-phoenix docs~~ getting-started-with-phoenix docs Feb 8, 2023

chrishop added a commit to team-alembic/my_ash_phoenix_project that referenced this pull request Feb 8, 2023

feat: full implementation of step by step tutorial wrt this proposed …

50a195a

…guide in ash-hq: ash-project/ash#504

Theosaurus-Rex reviewed Feb 8, 2023

View reviewed changes

documentation/tutorials/get-started-with-phoenix.md Outdated Show resolved Hide resolved

Theosaurus-Rex reviewed Feb 8, 2023

View reviewed changes

documentation/tutorials/get-started-with-phoenix.md Outdated Show resolved Hide resolved

martinstannard reviewed Feb 8, 2023

View reviewed changes