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

Make sure all v6 features are documented #450

Closed
22 of 24 tasks
tabacitu opened this issue Jul 2, 2023 · 3 comments
Closed
22 of 24 tasks

Make sure all v6 features are documented #450

tabacitu opened this issue Jul 2, 2023 · 3 comments

Comments

@tabacitu
Copy link
Member

tabacitu commented Jul 2, 2023

To document:

  • installation process now asks the developer which theme they want to install;
  • installation process currently favors installing CoreUIv2, so we can't say Tabler is the default just yet;
  • UPGRADE GUIDE - note all version of our packages that support Backpack v6, so it's easy for people to bump the version;
  • UPGRADE GUIDE - shouldn't we tell people to change all their custom pages to extend backpack_view('blank') because that's provided by all themes?
  • UPGRADE GUIDE: you should run php artisan backpack:install to properly install Basset and the theme;
  • UPGRADE GUIDE - shouldn't we tell people to delete their errors folder? if they haven't customized it with their own error views of course;
  • UPGRADE GUIDE - in v6 we define the uploaders in the crud.php config file; do we instruct people to add these in the upgrade guide? what happens if they don't do it? nothing; they will add them when they want to create custom uploaders; which is never;
  • UPGRADE GUIDE - in v6 all operations content class defaults to being wide (col-md-12); should we instruct people to do that in their upgrade guide? nah... let's let them keep their old width;
  • CrudButton now has metas and you can send variables to your buttons; is this documented anywhere?
  • CrudColumn is Macroable now; is that documented anywhere? should we?
  • CrudField is Macroable now; is that documented anywhere? should we?
  • are all Uploaders documented?
  • are all Uploaders referenced where they're most likely to be needed?
  • do our general-purpose docs and examples show Uploaders instead of mutators or model events?
  • we now have a few custom validation rules; are they well documented?
  • in v6 we add a way to quickly add a button - is that properly documented?
  • i'm pretty sure the bp-section classes we've added aren't documented at all; see this as an example;
  • we should document how someone uninstalls a Backpack theme; for ex in the upgrade process we instruct them to use CoreUIv2, and only after everything is workding... install Tabler and uninstall CoreUIv2; but we don't explain how to do that (uninstall);
  • currently our docs don't do a good job at highlighting how much of a team effort Backpack v6 was; we MUST give credit where credit is due; we must mention our team members by name; and thank them for their efforts;
  • we should mention how much work has gone into v6, with numbers:
  • our drip emails for "getting started" have not been updated for v6; at all!
  • spatie media library support is nowhere in the docs, only in the release notes;
  • The "How To" Page got a lot of old info which is not usable in v6 #488
  • CSS Hook section is missing in docs. #484
@tabacitu
Copy link
Member Author

tabacitu commented Jul 2, 2023

  • polish all pages that were noted here as not final:

CleanShot 2023-07-02 at 18 55 30

@tabacitu
Copy link
Member Author

CleanShot 2023-07-27 at 16 20 59

@pxpm
Copy link
Contributor

pxpm commented Jul 27, 2023

CleanShot 2023-07-27 at 16 20 59

I stared at this for a moment thinking you were reporting a bug because the file seems to "disapear" 🤷 funny!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

No branches or pull requests

2 participants