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

docs: Add additional information and tips to Backup & Restore Usage Documentation Page & Shopping List #4843

Open
wants to merge 12 commits into
base: mealie-next
Choose a base branch
from

Conversation

ChipSkylark37
Copy link
Contributor

What type of PR is this?

  • documentation

What this PR does / why we need it:

  • Adding notes regarding the Settings > Backup page in addition to the URL
  • Listed out some additional actions that can be performed in this page. Added a tip for manual review / adjustment of the database.json file in the event that a restore fails
  • Changed some verbiage (removing pluralization on some items)

Which issue(s) this PR fixes:

None - I am looking through some of the documentation and looking to offer some assistance on pieces that could use clarity or an update.

Special notes for your reviewer:

This is my first PR so I wanted to make some small changes to the documentation and see what the process looks like.

- Adding notes regarding the Settings > Backup page in addition to the URL
- Listed out some additional actions that can be performed in this page.
Added a tip for manual review / adjustment of the database.json file in the event that a restore fails
- Changed some verbiage (removing pluralization on some items)
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 6, 2025
@boc-the-git
Copy link
Collaborator

Thanks for taking the time to raise a PR @ChipSkylark37!

Whilst I haven't gone through the actual doco change in detail, there's 2 key things to address with the PR itself.

  1. You'll see that the CI checks are failing, that'll be because DOCS is not an allowable prefix for the PR title - docs is what you'd be after.
  2. The rest of the title itself could be more meaningful. Something generic like Update backups-and-restoring.md isn't overly useful to someone reading a changelog whereas (for example) something like Added additional information to the backup/restore documentation is a bit more meaningful.

- Adding notes regarding how to access via the Settings > Backup page in addition to the URL slug.
- Location of 'backup button' changed from bottom left to top left
 - Listed out some additional actions that can be performed in this page. 
- Added a tip for manual review / adjustment of the database.json file in the event that a restore fails
- Changed some verbiage (removing pluralization on some items)
@ChipSkylark37 ChipSkylark37 changed the title DOCS: Update backups-and-restoring.md docs: Add additional information and tips to Backup & Restore Usage Page Jan 7, 2025
@ChipSkylark37 ChipSkylark37 changed the title docs: Add additional information and tips to Backup & Restore Usage Page docs: Add additional information and tips to Backup & Restore Usage Documentation Page Jan 7, 2025
@ChipSkylark37
Copy link
Contributor Author

I believe I have corrected the errors and performed a new commit after syncing the latest nightly.

…med, tips, and some examples.

- Added location of Shopping Lists from Sidebar.
- Added some common things that can be done (See added items, see linked recipes, checking off an item, sorting items, creating / sorting labels.
- Added tip for unchecking a checked of item
- Added tip for using 'Food' / 'Smart Handling' to combine ingredients
- Added tip for using Labels to sort (however you may want)
@ChipSkylark37 ChipSkylark37 changed the title docs: Add additional information and tips to Backup & Restore Usage Documentation Page docs: Add additional information and tips to Backup & Restore Usage Documentation Page & Shopping List Jan 7, 2025
@ChipSkylark37
Copy link
Contributor Author

Additionally I made some changes to the Shopping List Section.

Would it be recommended to start a new commit for each one of these? I'm still learning the system a bit so I could use some advice on that.

@ChipSkylark37
Copy link
Contributor Author

Hey all - I was just recently moving my instance from SQL > Postgres and was going to update the documentation a bit more.

I synced the latest mealie:nightly to my own fork, which overwrote the documentation changes in my local fork.

If this PR gets merged, I can then resync and do some further updates.

Is there anything I need to do to help get these changes merged?

@boc-the-git
Copy link
Collaborator

Would it be recommended to start a new commit for each one of these?

Depends if you mean commit or pull request.
Generally, yes it's best to have different commits for unrelated changes - though in the case of docs that isn't critically important.

As for a pull request, the general rule is that the smaller the better, as it allows for it to be reviewed more easily. Again for docs though, it's a grey area.

@boc-the-git
Copy link
Collaborator

I synced the latest mealie:nightly to my own fork, which overwrote the documentation changes in my local fork.

They'd still exist on the branch they belong to - you can see them on here: https://github.com/ChipSkylark37/mealie/tree/patch-1

docs/docs/documentation/getting-started/features.md Outdated Show resolved Hide resolved
docs/docs/documentation/getting-started/features.md Outdated Show resolved Hide resolved
docs/docs/documentation/getting-started/features.md Outdated Show resolved Hide resolved
docs/docs/documentation/getting-started/features.md Outdated Show resolved Hide resolved
ChipSkylark37 and others added 3 commits January 12, 2025 09:26
I agree with the changes to make this read better.

Co-authored-by: boc-the-git <[email protected]>
Accepted suggestion for how 'Unchecking' an item is handled.

Co-authored-by: boc-the-git <[email protected]>
- Changed language as per suggestions: mealie-recipes#4843
- Moved around some of the tips that were added
- Added a note on using a 'Want to Make' tag under Cookbooks as per a discord conversation with Michael (great tip!)
Copy link
Contributor Author

@ChipSkylark37 ChipSkylark37 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed and make changes per conversations.

docs/docs/documentation/getting-started/features.md Outdated Show resolved Hide resolved
docs/docs/documentation/getting-started/features.md Outdated Show resolved Hide resolved
docs/docs/documentation/getting-started/features.md Outdated Show resolved Hide resolved
@ChipSkylark37
Copy link
Contributor Author

Forgive me as I don't want to spam, but I believe I've made all requested changes.

Since I'm still new to this, I can't tell if there's any action needed on my part or if this is all the normal checks / waiting for someone else to review & approve.

Cheers!

@Kuchenpirat
Copy link
Collaborator

If you have addressed the feedback above you should be all good to go.
We are a pretty small team with a lot of things going on outside of unpaid work for mealie, so things might take time.
As this is just a little docs pr where not much testing is needed, I expect it to be addressed sooner rather than later.

- Removed Images until I can determine the best way to upload them (or use the SVG files)
- Fixed the 'four spaces' instead of using a Tab.
Copy link
Contributor Author

@ChipSkylark37 ChipSkylark37 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed suggested changes:

  • (Hopefully) fixed the indentation. I used a 'Tab' instead of 'Four Spaces'
  • Removed images / assets temporarily while I think about the best way to do this moving forward since I like the idea of images, but dont want to have to upload images each time.

To avoid confusion / manual modifications, removing the note of "Make it Later'
Copy link
Contributor Author

@ChipSkylark37 ChipSkylark37 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed 'Make Later'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants