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

document multi-user usage of same budget file #496

Merged
merged 6 commits into from
Jan 9, 2025

Conversation

meonkeys
Copy link
Contributor

@meonkeys meonkeys commented Nov 26, 2024

Discussed in:

Could someone with intimate knowledge of the syncing architecture/CRDTs/etc. validate and help me perfect the text? I took the conservative approach with my "To be safe..." comment, but if it truly is fine to edit simultaneously, we should say so less conservatively. Moreso, if simultaneous edits are supported behavior, we should also take this page out of "experimental".

@actual-github-bot actual-github-bot bot changed the title document multi-user usage of same budget file [WIP] document multi-user usage of same budget file Nov 26, 2024
Copy link

netlify bot commented Nov 26, 2024

Deploy Preview for actualbudget-website ready!

Name Link
🔨 Latest commit 9b6012f
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget-website/deploys/67478614f2229a0008fdff4f
😎 Deploy Preview https://deploy-preview-496.www.actualbudget.org
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

# Multi-user

:::warning
This is an **experimental feature**. That means we’re still working on finishing it. There may be bugs, missing functionality or incomplete documentation, and we may decide to remove the feature in a future release. If you have any feedback, please [open an issue](https://github.com/actualbudget/actual/issues) or post a message in the Discord.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
This is an **experimental feature**. That means we’re still working on finishing it. There may be bugs, missing functionality or incomplete documentation, and we may decide to remove the feature in a future release. If you have any feedback, please [open an issue](https://github.com/actualbudget/actual/issues) or post a message in the Discord.
This is an **experimental feature**, which means we’re still working on finishing it. There may be bugs, missing functionality, or incomplete documentation, and we may decide to remove the feature in a future release. If you have any feedback, please [open an issue](https://github.com/actualbudget/actual/issues) or post a message in Discord.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I just copied this section from one of the other experimental pages, so maybe fix them all in one (separate) PR? Also see below... sounds like we might want to move this out of "Experimental" altogether since it isn't like the other actually checkbox-toggled experimental features.

docs/experimental/multi-user.md Outdated Show resolved Hide resolved
@matt-fidd
Copy link
Contributor

The experimental section in the docs is only used for experimental features (shown in the settings page of Actual)

image

Multi user (in this capacity) is not a feature in itself, but the ability can be documented on another page if you'd like to copy what you've done to another relevant page.

@meonkeys
Copy link
Contributor Author

@matt-fidd good call, will do.

@meonkeys
Copy link
Contributor Author

Do you prefer commits squashed or as-is?

@matt-fidd
Copy link
Contributor

Do you prefer commits squashed or as-is?

As-is is fine, we squash merge anyway

Copy link
Contributor

@matt-fidd matt-fidd left a comment

Choose a reason for hiding this comment

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

Great, thank you! Will let @RubenOlsen have the final say before it goes in

@matt-fidd
Copy link
Contributor

With official multi-user support now in Actual as an experimental feature I think this might be confusing to have in the docs as-is.

I'd be happy to have it in if the multi user section was dropped, and the text was moved into the block where the link is currently

Comment on lines +93 to +96

## Multi-user Support

The same budget file may be opened and edited simultaneously from two separate browsers, even by two different people on different client computers. This should work unless the edits conflict. To be safe, avoid simultaneous usage of the same budget file.
Copy link
Contributor

Choose a reason for hiding this comment

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

Could the section here be removed and the text moved into joint-accounts.md where the link is currently?

Copy link
Member

Choose a reason for hiding this comment

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

I suggest leaving it here (to get it out the door) - but also have a variant of the same in the joint accounts.md file. If you agree, @matt-fidd, I further suggest opening an enhancement request. There is no shame in repeating ourself (a little bit).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm fine either way, FWIW

Copy link
Contributor

Choose a reason for hiding this comment

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

I suggest leaving it here (to get it out the door) - but also have a variant of the same in the joint accounts.md file. If you agree, @matt-fidd, I further suggest opening an enhancement request. There is no shame in repeating ourself (a little bit).

Yeah, let's leave it here for now. We can revisit when proper multi user is released first party

@matt-fidd matt-fidd changed the title [WIP] document multi-user usage of same budget file document multi-user usage of same budget file Dec 24, 2024
@actual-github-bot actual-github-bot bot added 🔍 Ready for review Someone needs to look into this. and removed 🚧 WIP labels Dec 24, 2024
@actual-github-bot actual-github-bot bot added ⚠️ Changes requested and removed 🔍 Ready for review Someone needs to look into this. labels Jan 3, 2025
@matt-fidd matt-fidd dismissed their stale review January 5, 2025 15:57

Feedback

@actual-github-bot actual-github-bot bot added ✅ Approved Used in conjunction with Merge at Release. This means that the PR has been approved but not merged. and removed ⚠️ Changes requested labels Jan 5, 2025
@youngcw youngcw merged commit 89c0254 into actualbudget:master Jan 9, 2025
6 checks passed
@actual-github-bot actual-github-bot bot added ✨ Merged and removed ✅ Approved Used in conjunction with Merge at Release. This means that the PR has been approved but not merged. labels Jan 9, 2025
@meonkeys meonkeys deleted the multi-user branch January 9, 2025 20:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants