forem / admin-docs

Empowering Forem Creators
24 stars 24 forks source link

Update "Forem Setup Checklist" Documentation #26

Closed juliannatetreault closed 2 years ago

juliannatetreault commented 2 years ago

Explain the changes

With the new-and-improved Creator Onboarding flow, the "Verify Setup" banner and "Getting Started" section are no longer as useful as they once were. This being said, we have removed the "Verify Setup" banner from the site and plan on removing the "Getting Started" section from the Config. In our Admin documentation, we have a brief section that explains both the "Verify Setup" banner and the "Getting Started" section in the Config. With the removal of both, we'll also want to remove the documentation for them.

Suggested changes

The following changes will need to be made:

Additional context

The PR for the removal of the "Verify Setup" banner has been merged, but the PR for the removal of the "Getting Started" section is in a draft mode and will remain in a draft mode until I speak with @Ridhwana further about how to best communicate this change. This being said, I will provide updates on when the work is actually merged so that we can coordinate the removal of the references to this section from the documentation (if that works for y'all!). šŸ˜Š

ellativity commented 2 years ago

Thanks for this issue, @juliannatetreault šŸ™Œ

Since I don't run a local development instance of Forem, I can only take these screenshots when provisioning a new Forem. Is there any way you can make up-to-date duplicates of these images, please? Then I can modify the text and remove all visual references to the "Verify Setup" banner!

Navigate to your Admin Portal by appending /admin to the homepage URL of your Forem (e.g. dev.to/admin) or selecting Admin from the dropdown menu under your profile image at the top-right of your screen:

drop down menu screenshot

And

Navigate to /admin/customization/config using the Admin Navigation menu.

admin/customization/config

Really appreciate your help here. I hope our next new Forem provisioning will coincide with the next PR, so we can create new screenshots of the process!

juliannatetreault commented 2 years ago

I can absolutely take screenshots for you, @ellativity!

Really appreciate your help here.

Likewise! šŸ˜Š

juliannatetreault commented 2 years ago

Here are the screenshots, @ellativity!

Navigate to your Admin Portal by appending /admin to the homepage URL of your Forem (e.g. dev.to/admin) or selecting Admin from the dropdown menu under your profile image at the top-right of your screen:

Screen Shot 2022-01-20 at 9 51 17 AM

Navigate to /admin/customization/config using the Admin Navigation menu:

Screen Shot 2022-01-20 at 9 47 16 AM

Feel free to update the documentation whenever, as the feature will be live on all Forems with the next deploy!

ellativity commented 2 years ago

Thanks @juliannatetreault

juliannatetreault commented 2 years ago

Thank YOU, @ellativity!!

ellativity commented 2 years ago