[RF-DOCS] Sign up guide

[excid3]

Motivation / Background

This is a continuation of the Getting Started guide.

Detail

After building the e-commerce store, this guide adds:

• Sign up
• Edit profile
• Edit password
• Change email address with email confirmation
• Delete account
• Admin role
• Admin area for product management

Additional information

Checklist

Before submitting the PR make sure the following are checked:

• This Pull Request is related to one change. Unrelated changes should be opened in separate PRs.
• Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: [Fix #issue-number]
• Tests are added or updated if you fix a bug or add a feature.
• CHANGELOG files are updated for the changed libraries if there is a behavior change or additional feature. Minor bug fixes and documentation changes should not be included.

cc @AmandaPerino

[MatheusRich]

@excid3 how does one get to this guide? Is it linked from the Getting Started one?

[p8]

@MatheusRich @excid3 It needs to be added to:
https://github.com/rails/rails/blob/main/guides/source/documents.yaml

[excid3]

There are design changes coming so it will be done in a separate PR.

[AmandaPerino]

@MatheusRich @p8 Just like the /docs landing page we launched last year, we are building a Tutorial landing page where all of the tutorials, and all upcoming tutorials will live. (PR here.)

[MatheusRich]

@AmandaPerino amazing! For anyone reviewing and wants to preview the results:

1. Find the latest build preview in the GH action:

2. Add /guides/sign_up_and_settings.html to the end of that URL

[MatheusRich]

Great tutorial, as always @excid3! So easy to follow and yet very comprehensive! I love how clean the code is and all the little details you put here and there. It shows your deep understanding of the Rails-way. It teaches so much more than the title says. Well done!

[p8]

@MatheusRich @p8 Just like the /docs landing page we launched last year, we are building a Tutorial landing page where all of the tutorials, and all upcoming tutorials will live.

@AmandaPerino That looks great!
If these tutorials are part of https://github.com/rails/website would it make sense to move this PR there as well?

[AmandaPerino]

It's easier to keep the website and tutorials in sync if they are in the same repo. For example, new guides will only be published when a new version of Rails is released (major or minor). If we add tutorials to /website they get published right away after merging.

If a lot of tutorials get added to the guides (without making them part of the guides), the guides get more difficult to maintain. There will just be more text to maintain and fixes would need to get backported.

I would also expect navigation for tutorials to be slightly different than for guides?

That makes sense to me for the new tutorials, but a little less clear how that would work with the Getting Started guide.

It feels like the GS guide should stay in the guides.ror.org subdomain. But I'm open to differing thoughts here- is there any valid reason stopping it from also moving to /tutorials?

If it stays on the subdomain, the navigation from that tutorial to the others feels less clean.

[GithinjiV]

Good job @excid3! Thank you for your continous contribution to the rails community!

[p8]

That makes sense to me for the new tutorials, but a little less clear how that would work with the Getting Started guide.

It feels like the GS guide should stay in the guides.ror.org subdomain. But I'm open to differing thoughts here- is there any valid reason stopping it from also moving to /tutorials?

If it stays on the subdomain, the navigation from that tutorial to the others feels less clean.

I can't imagine someone reading the "Getting Started" guide from Rails version 6.0.

The use case for the "Getting Started" guide is a bit different than other guides. Most would probably read it once to build an app and never look at it again, whereas the other guides are used to look up things more often.

The guides for older Rails version are useful when you are working on an application with that same version.
This doesn't apply that much to the "Getting Started" guide. If you install Rails for the first time you get the latest version, so for the "Getting Started" guide we probably only want to show the latest version (which helps when it's on /website instead of /rails).

So maybe it's a good idea to move that guide to /website as well?

There are some existing guides which are more tutorial like. For example the plugins guide: https://guides.rubyonrails.org/plugins.html. I'm not sure those should be moved as well.

[NotGrm]

This is a really great guide! Despite using Rails for years, I learned a few interesting things.

What do you think about inserting tests throughout the guide, after introducing new requirements and before showing code blocks? This could help foster a TDD/test-first culture among readers.

[MichaelGame-Dev]

@AmandaPerino amazing! For anyone reviewing and wants to preview the results:

1. Find the latest build preview in the GH action:

2. Add `/guides/sign_up_and_settings.html` to the end of that URL

@MatheusRich I am trying to do just that,
Adding /guides/sign_up_and_settings.html to the end after clicking on buildkite link just ends up with a page that doesn't exist. New to Rails and the more complex stuff in Github. So can't seem to figure out how to get the latest version of the guide to look through.

[MatheusRich]

@MichaelGame-Dev the page has changed a little since i've last saw this, but you can find the docs link in the Annotations section:

Click on Guides and add /guides/sign_up_and_settings.html as the path. The current link would be https://2d4dd8e7.rails-docs-preview.pages.dev/guides/sign_up_and_settings.html

[p8]

@excid3 Before this gets merged, could you wrap to 80 columns?
https://edgeguides.rubyonrails.org/ruby_on_rails_guides_guidelines.html#column-wrapping

[excid3]

@p8 done!