Repository navigation
docs: deploy databases/keys, admin setup guide, design next steps - #149
Merged
Merged
Conversation
- DEPLOYING: Rails 8's cache/queue/cable databases need their own URLs (db:prepare fails on a local socket otherwise, seen in Docker); the encryption keys production needs. Kamal template lists the URLs. - New how-to: SETTING_UP_ADMIN.md; linked from the site sidebar, doc index, README, and Getting Started. Every step verified in a generated app, including a custom Project dashboard and the before_admin_action example. - Admin fix found while writing it: with only core+auth installed every admin page 500'd (navigation touched Accounts/Billing models). Missing engines' dashboards are hidden and 404. - Admin README: accurate custom-dashboard recipe; theme_css_path is documented as not applied yet (it is stored but unused). - Design generator: tailwindcss:build is marked required.
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fills the three gaps I reported after the onboarding fix, plus two bugs found while doing it.
1. Deploying guide
DATABASE_URLonly sets upprimary, sodb:preparefails on a local socket for cache, queue and cable. I hit this running a generated app in Docker. The fix isCACHE_DATABASE_URL,QUEUE_DATABASE_URLandCABLE_DATABASE_URL, which I verified there.deploy.ymlnow lists the three extra database URLs.2. Admin setup guide
New
doc/how-to/SETTING_UP_ADMIN.md: install, the staff flag, what each kind of visitor sees, platform vs tenant mode,before_admin_action, ejecting, adding your own dashboard, and troubleshooting. It's linked from the site sidebar, the doc index, the README and Getting Started.I checked every step in a generated app:
Projectmodel: index, new, show and edit return 200, and it appears in the sidebar.before_admin_actionIP example returns 403 from other IPs and 200 from10.x.3. Design generator message
bin/rails tailwindcss:buildis now marked required, and the message names the error you get without it. It has a spec.Bugs found while writing these
coreandauthonly, the navigation loaded dashboards for missing models (uninitialized constant Accounts). Dashboards whose engine isn't installed are now hidden and return 404. Production eager loading passes. Has a spec.self.model, the policies, the leading-slash route, and deleting Administrate's generated host controller, which bypasses the gate. The README also claimedtheme_css_pathrestyles the admin. The setting is stored but never applied, so the README now says so.Checks