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

Added the legal docs as a submodule #16791

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added the legal docs as a submodule #16791

wants to merge 1 commit into from

Conversation

Samyoul
Copy link
Member

@Samyoul Samyoul commented Nov 21, 2024

Resolves #16787
See status-im/status-software-legal-documents#5
Also see: status-im/status-mobile#21654

Adding the status-software-legal-documents repo as a submodule makes life easier by keeping all legal documents consistent across platforms. Instead of copying files around and hoping they stay in sync, we can just point to the same source. This way, any updates to the main legal docs automatically flow to all the repos, reducing the chances of mistakes or outdated files. It’s a simple, reliable way to stay organised and keep everything aligned.

@Samyoul Samyoul requested review from a team, iurimatias and osmaczko and removed request for a team November 21, 2024 12:22
@Samyoul Samyoul requested a review from a team as a code owner November 21, 2024 12:22
@Samyoul
Copy link
Member Author

Samyoul commented Nov 21, 2024

If you @status-im/desktop-core guys want me to move the submodule somewhere else I am happy to do that, I just placed it in the same dir as the existing legal docs

@status-im-auto
Copy link
Member

status-im-auto commented Nov 21, 2024

Jenkins Builds

Commit #️⃣ Finished (UTC) Duration Platform Result
✔️ 92f02fe #1 2024-11-21 12:31:12 ~8 min tests/nim 📄log
✔️ 92f02fe #1 2024-11-21 12:31:31 ~8 min macos/aarch64 🍎dmg
92f02fe #1 2024-11-21 12:37:11 ~14 min tests/ui 📄log
✔️ 92f02fe #1 2024-11-21 12:38:15 ~15 min macos/x86_64 🍎dmg
✔️ 92f02fe #1 2024-11-21 12:42:44 ~19 min linux-nix/x86_64 📦tgz
✔️ 92f02fe #1 2024-11-21 12:43:14 ~20 min linux/x86_64 📦tgz
✔️ 92f02fe #1 2024-11-21 12:43:55 ~20 min windows/x86_64 💿exe

Copy link
Member

@caybro caybro left a comment

Choose a reason for hiding this comment

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

LGTM!

@igor-sirotin
Copy link
Contributor

igor-sirotin commented Nov 21, 2024

... move the submodule somewhere else I am happy to do that

@Samyoul I guess it would make sense to be in the vendor directory. But depends on if we import these files in QML or not, I have no idea 🙂
cc @alexjba @micieslak

@alexjba
Copy link
Contributor

alexjba commented Nov 21, 2024

... move the submodule somewhere else I am happy to do that

@Samyoul I guess it would make sense to be in the vendor directory. But depends on if we import these files in QML or not, I have no idea 🙂 cc @alexjba @micieslak

I think you're right! vendor seems to be the right place. Even if we'll need it in qml, we'll find a way. As we do now for qzxing

@caybro
Copy link
Member

caybro commented Nov 21, 2024

... move the submodule somewhere else I am happy to do that

@Samyoul I guess it would make sense to be in the vendor directory. But depends on if we import these files in QML or not, I have no idea 🙂 cc @alexjba @micieslak

Yeah... good point; the idea is that we'll want to import these Markdown files, instead of ui/imports/assets/docs/privacy.mdwn and ui/imports/assets/docs/terms-of-use.mdwn

@alexjba
Copy link
Contributor

alexjba commented Nov 21, 2024

Yeah... good point; the idea is that we'll want to import these Markdown files, instead of ui/imports/assets/docs/privacy.mdwn and ui/imports/assets/docs/terms-of-use.mdwn

StatusQ is already importing vendor modules. Do you think it will be an issue to add this as well as a dependency?

@caybro
Copy link
Member

caybro commented Nov 21, 2024

Yeah... good point; the idea is that we'll want to import these Markdown files, instead of ui/imports/assets/docs/privacy.mdwn and ui/imports/assets/docs/terms-of-use.mdwn

StatusQ is already importing vendor modules. Do you think it will be an issue to add this as well as a dependency?

Dunno, we just need to make sure it gets included in the autogenerated qrc file

@Samyoul
Copy link
Member Author

Samyoul commented Nov 21, 2024

@alexjba and @caybro is it possible to replace the use of ui/imports/assets/docs/privacy.mdwn and ui/imports/assets/docs/terms-of-use.mdwn with the contents of https://github.com/status-im/status-software-legal-documents?

So instead of pulling in the markdown from this repo it gets pulled in directly from https://github.com/status-im/status-software-legal-documents?

@caybro
Copy link
Member

caybro commented Nov 21, 2024

@alexjba and @caybro is it possible to replace the use of ui/imports/assets/docs/privacy.mdwn and ui/imports/assets/docs/terms-of-use.mdwn with the contents of https://github.com/status-im/status-software-legal-documents?

So instead of pulling in the markdown from this repo it gets pulled in directly from https://github.com/status-im/status-software-legal-documents?

Yeah, I think it would be just a matter of fixing the ui/generate-rcc.go to include those 2 files from the submodule, and maybe adjusting some paths in QML

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

Successfully merging this pull request may close these issues.

Add status-software-legal-documents as a Git Submodule in status-desktop
5 participants