Conversation
Added the page, including overview/intro text and content for "Natively supported Cloud Services" section Added the page to "index.rst" Moved content from "Android/Setup" to "Supported Cloud Services" page Refactored linebreaks and links on "Android/Setup" page Overhauled text on "Android/Setup" page
The table and footnotes originate here: https://community.cryptomator.org/t/webdav-urls-of-common-cloud-storage-services/75
Replaced asterisks with actual footnotes Split footnotes for "HiDrive IONOS" and "HiDrive Strato" Reordered "Cloud Services with WebDAV support" table Reordered and cleaned up corresponding footnotes
Refactored surrounding text to match added notes Added required CSS
Replaced now outdated links with links to "Supported Cloud Services" page Unified terminology
|
Caution Review failedThe pull request is closed. WalkthroughThe changes consist of updates to several documentation files and a new CSS class in the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Cryptomator
participant CloudService
User->>Cryptomator: Install app
Cryptomator->>CloudService: Connect to Cloud Service
CloudService-->>Cryptomator: Authentication
Cryptomator-->>User: Access vaults
Possibly related PRs
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (14)
source/index.rst (1)
93-93: LGTM! Consider alphabetical ordering.The addition of
misc/supported-cloud-services.rstto the "Misc" section is correct and well-formatted. It aligns with the PR objective of adding a page for supported Cloud Services.For improved organization, consider placing the new entry in alphabetical order within the "Misc" section. This would mean moving it before
misc/vault-format-history.rst. Here's a suggested change:.. toctree:: :hidden: :maxdepth: 2 :caption: Misc misc/contribute.rst - misc/supported-cloud-services.rst misc/vault-format-history.rst + misc/supported-cloud-services.rstThis is a minor suggestion and is not required for approval.
source/_static/css/overrides.css (2)
38-39: Minor improvements to code structureThe addition of the closing brace on line 38 corrects a syntax error, and the blank line on line 39 improves readability. These are good changes.
For consistency, consider adding a blank line before the
.rst-content .highlightsselector as well. This would further improve readability and maintain a consistent style throughout the file.
Line range hint
1-43: Suggestions for improving file organizationThe changes made to this file are good and consistent with the existing styles. To further improve the maintainability of this CSS file, consider the following suggestions:
- Group related styles together. For example, all styles related to links could be placed in one section.
- Add comments to separate different sections of the stylesheet (e.g., // Typography, // Alerts, // Custom highlights).
- Consider using CSS custom properties (variables) for colors that are used multiple times, like #66CC68. This would make it easier to maintain a consistent color scheme.
Here's an example of how you could start organizing the file:
/* Typography */ .wy-menu-vertical header, .wy-menu-vertical p.caption { /* ... */ } /* Links */ a { /* ... */ } a:hover { /* ... */ } /* Form elements */ .wy-side-nav-search input[type="text"] { /* ... */ } /* Alerts and notes */ .rst-content .note .admonition-title, /* ... other selectors ... */ { /* ... */ } /* Custom highlights */ .rst-content .highlights { /* ... */ }This organization will make the file easier to navigate and maintain in the future.
source/android/cloud-management.rst (1)
63-64: LGTM: Improved self-containment and clarityThe replacement of the external link with an internal reference enhances the document's self-containment and provides a more comprehensive description of the referenced content. This change improves the overall user experience by keeping readers within the documentation.
Consider adding a brief explanation of what WebDAV is for users who might be unfamiliar with the term. For example:
Please see :ref:`misc/supported-cloud-services/clouds-with-webdav-support` for a non-exhaustive list of Cloud Services -and information about accessing them with WebDAV. +and information about accessing them with WebDAV (a protocol for accessing and managing files on remote web servers).source/misc/supported-cloud-services.rst (2)
27-52: Consider improving footnote formattingThe content in this section is informative and well-structured. The use of a CSV table for supported cloud services is a good choice for maintainability.
However, consider improving the readability of the footnote markers by adding a space before them. For example:
-.. [#playstore-recommendation] **We recommend using the** |GooglePlayStoreVariant|_ **of Cryptomator for Android users** +.. [#playstore-recommendation] **We recommend using the** |GooglePlayStoreVariant|_ **of Cryptomator for Android users** [#playstore-recommendation]_This change would make the footnote references more visible and easier to distinguish from the surrounding text.
54-77: Consider standardizing footnote content structureThe information provided in this section is comprehensive and valuable. The use of footnotes for service-specific details is a good approach.
To improve consistency and readability, consider standardizing the structure of the footnote content. For example:
- Start each footnote with the service name in bold.
- Use a consistent format for presenting information about authentication, 2FA, and other specifics.
Example:
.. [#note-disroot] **Disroot:** Login requires your Disroot username (or email if using your own domain) and password. If 2FA is enabled, an app-specific password must be generated. .. [#note-hidrive-ionos] **HiDrive IONOS:** When using 2FA, WebDAV requires the OTP provided next to the password. Note: OTP is only valid for 30 minutes. (See `here [de] <https://www.ionos.de/hilfe/hidrive/sicherheit-in-hidrive/aktivieren-der-zwei-faktor-authentifizierung/>`__)This standardization would make it easier for users to quickly find and understand the specific requirements for each service.
source/android/setup.rst (5)
6-15: Improved clarity and guidance for app installation sources.The changes in this section enhance readability and provide clearer guidance to users. The simplified bullet points and the added information about app functionality across variants are helpful. The recommendation for the Google Play Store variant is a good addition for users who have access to it.
Consider adding a brief explanation of why the Google Play Store variant is recommended (e.g., "for easier updates and integrated payment").
19-41: Comprehensive explanation of variant differences and selection criteria.The expanded and restructured section provides valuable information to help users choose the most appropriate variant. The detailed explanations of each variant's characteristics, including supported cloud services and licensing requirements, are particularly helpful.
Consider adding a small comparison table or bullet-point list summarizing the key differences between variants for quick reference.
45-56: Enhanced information for Google Play Store variant users.The updates in this section provide valuable information about family sharing and potential purchase recognition issues. The added details and link to the community topic are helpful for users who might encounter problems.
Consider formatting the URL for the family library information as a hyperlink for consistency with other links in the document.
63-73: Improved guidance for APK Store variant installation and licensing.The updates in this section provide clear instructions for installing the APK Store variant and obtaining a license. The added information about the automatic updater is particularly useful for users choosing this variant.
Consider adding a note about the importance of keeping the app updated for security reasons, emphasizing the benefit of the automatic updater.
100-110: Comprehensive information for Main F-Droid repository variant.The updates in this section provide clear instructions for installing and licensing the Main F-Droid repository variant. The explanation about the different package name and its implications is particularly valuable for users.
Consider adding a brief note about the pros and cons of choosing this variant compared to others, to help users make an informed decision.
source/android/vault-management.rst (3)
25-31: Approved changes with a minor suggestion.The modifications improve consistency in terminology and provide valuable information about WebDAV access and supported Cloud Services. This aligns well with the PR objective.
Consider adding a brief explanation of what WebDAV is for users who might be unfamiliar with the term. For example:
- | If your desired provider is not listed and offers WebDAV access, please select *WebDAV* as the storage location of your vault. + | If your desired provider is not listed and offers WebDAV access (a protocol for online file storage and sharing), please select *WebDAV* as the storage location of your vault.
92-98: Approved changes with a minor suggestion for consistency.The modifications in this section mirror those made earlier, maintaining consistency in terminology and providing valuable information about WebDAV access and supported Cloud Services. This aligns well with the PR objective.
For consistency with the earlier suggestion, consider adding a brief explanation of WebDAV here as well:
- | If your desired provider is not listed and offers WebDAV access, please select *WebDAV* as the storage location of your vault. + | If your desired provider is not listed and offers WebDAV access (a protocol for online file storage and sharing), please select *WebDAV* as the storage location of your vault.
Inconsistent Terminology Found
The term "cloud provider" is used in
source/security/security-target.rst. Please update it to "Cloud Service" to maintain consistency across all documentation.
source/security/security-target.rst🔗 Analysis chain
Line range hint
1-270: Verify terminology consistency across documentation.While the changes in this file are appropriate and valuable, it's important to ensure consistency across all documentation files.
To maintain a uniform user experience, please run the following script to check for any remaining instances of "cloud provider" in other documentation files:
If any inconsistencies are found, please update them to match the terminology used in this file.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check for remaining instances of "cloud provider" in documentation files. # Test: Search for "cloud provider" in all .rst files. Expect: No matches found. rg --type rst "cloud provider" # Test: Verify consistent usage of "Cloud Service" in all .rst files. Expect: Consistent capitalization and usage. rg --type rst "Cloud Service"Length of output: 5152
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (3)
source/_static/csv/clouds-with-webdav-support.csvis excluded by!**/*.csvsource/_static/csv/incompatible-clouds.csvis excluded by!**/*.csvsource/_static/csv/natively-supported-clouds.csvis excluded by!**/*.csv
📒 Files selected for processing (7)
- source/_static/css/overrides.css (1 hunks)
- source/android/cloud-management.rst (2 hunks)
- source/android/settings.rst (3 hunks)
- source/android/setup.rst (2 hunks)
- source/android/vault-management.rst (3 hunks)
- source/index.rst (1 hunks)
- source/misc/supported-cloud-services.rst (1 hunks)
✅ Files skipped from review due to trivial changes (1)
- source/android/settings.rst
🔇 Additional comments (10)
source/_static/css/overrides.css (1)
40-43: LGTM: New highlights class added successfullyThe new
.rst-content .highlightsclass has been implemented correctly. It provides a visually distinct style for highlighted content, which is consistent with the overall theme. The left border color (#66CC68) matches other accent colors used in the stylesheet, maintaining visual coherence.source/android/cloud-management.rst (2)
16-16: LGTM: Improved terminology consistencyThe capitalization of "Cloud Service" enhances the consistency of terminology throughout the document. This change improves readability and maintains a professional tone.
Line range hint
1-114: Overall: Improved documentation clarity and consistencyThe changes made to this document enhance its quality in several ways:
- Consistent terminology use with the capitalization of "Cloud Service".
- Improved self-containment by replacing an external link with an internal reference.
- More comprehensive description of the referenced content for WebDAV support.
These modifications contribute to a better user experience without altering the document's primary purpose of guiding users through cloud service connections in the Cryptomator app.
source/misc/supported-cloud-services.rst (3)
1-25: LGTM: Well-structured and informative introductionThe introduction provides a clear and concise overview of Cryptomator's use with cloud services. It effectively explains the differences between desktop and mobile applications, and sets up the structure for the rest of the document.
78-88: LGTM: Clear information on incompatible servicesThis section effectively communicates which cloud services are not compatible with Cryptomator. The use of a CSV table is consistent with previous sections, maintaining a uniform structure throughout the document.
90-91: LGTM: Proper replacement definitionThe replacement definition for "GooglePlayStoreVariant" is correctly implemented and used in the document.
source/android/setup.rst (2)
80-93: Clear instructions for Cryptomator F-Droid repository variant.The updates in this section provide comprehensive guidance for users choosing the F-Droid repository variant. The inclusion of licensing information and the QR code for easy repository addition are particularly useful improvements.
124-129: Clear explanation of update rollout for different variants.The updates in this section provide a concise and clear explanation of the update timing for each variant. This information is valuable for users to understand when they can expect updates based on their chosen installation method.
source/android/vault-management.rst (2)
48-48: LGTM: Consistent terminology update.The replacement of "cloud provider" with "Cloud Service" maintains consistency with earlier changes and preserves the clarity of the instruction.
Line range hint
1-270: Overall assessment: Consistent and valuable improvements.The changes made to this document effectively standardize terminology by replacing "cloud provider" with "Cloud Service" throughout. The additions regarding WebDAV access and supported Cloud Services provide valuable information for users. These modifications align well with the PR objective of adding information about supported Cloud Services.
The rest of the document maintains its existing structure and content, ensuring that the changes integrate seamlessly with the overall documentation.
SailReal
left a comment
SailReal
left a comment
There was a problem hiding this comment.
LGTM, just a few minor things.
As we already discussed, even that I am quite aware of what works with what, I find it really hard to understand the footnotes in this table. I've thought about it a bit more and think we need a different way of displaying them, because I would suggest that most users will not understand them in the time they give the table before they skip it.
In the WebDAV section, they are fine.
Co-authored-by: Julian Raufelder <Julian@Raufelder.com>
JaniruTEC
changed the title
2 participants
No description provided.