Code Monkey home page Code Monkey logo

docs-client-android's Introduction

Android App Documentation

Table of Contents

Building the Android Docs

The Android app documentation is not built independently. Instead, it is built together with the main documentation. However, you can build a local copy of the Android documentation to preview changes you are making.

Whenever a Pull Request of this repo gets merged, it automatically triggers a full docs build.

General Notes

To make life easier, most of the content written in docs applies also here. For ease of reading, the most important steps are documented here too. For more information see the link provided. Only a few topics of this repo are unique like the branching.

Generating the Documentation

See the Generating the Documentation in the docs repo for more details as it applies to all documentation repositories.

Target Branch and Backporting

See the the following section as the same rules and notes apply.

Branching Workflow

Please refer to the Branching Workflow for the Android app for more information.

Create a New Version Branch for the Android App

Please refer to Create a New Version Branch for the Android App for more information.

docs-client-android's People

Contributors

dependabot[bot] avatar eparzefall avatar michaelstingl avatar mmattel avatar pascalwengerter avatar phil-davis avatar wkloucek avatar xoxys avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docs-client-android's Issues

2.20 Release

Features to include in the release. You can find the changelog here

I will briefly comment the enhancements. I guess bugfixes does not have nothing to do with documentation (let me know if i'm wrong)

Enhancement - Lock delay for app: #3344

Before: App is locked immediately when user selects a locking method (passcode/pattern/biometrical)

2.20: User can set a delay, so that the app will not be locked till this time passes. It is useful if user works together with other app. Every time app is switched, passcode/pattern is skipped during the chosen gap time:

Screenshot 2022-01-24 at 14 25 31

Enhancement - Lock access from document provider preference: #3520

Before: If the ownCloud app is locked with pattern lock or passcode, access to document provider was forbidden.

2.20: new security setting that let users decide whether the document provider access to the ownCloud files and folders is locked, regardless the locking methods.

Screenshot 2022-02-07 at 12 40 04

Enhancement - Security enforced: #3434

Before : Security is optional, users decide by themselves whether they want to lock the app or not

2.20: New branding option, so, the app will be always locked using pattern/passcode when the option is true. This feature will not be available for Google Play users, only for customers (ownBrander and future MDM). That means, the "Before" scenario will be the same for those users in 2.20.

Enhancement - Respect capability for Avatar support: #3438

Before: User avatar always shown

2.20: Supporting new server capability to show/hide avatars depending on its value

Enhancement - Brute force protection: #3320

Before: Users could try as many attempts as they want to enter a correct passcode.

2.20: Users have 3 attempts. After that, every attempt is only posible after waiting an increasing amount of time.

Enhancement - "Open with" action now allows editing: #3475

Before: The Open with action in the file list opens the file with external app but not posible to save changes back to the server.

2.20: The Open with action in the file list opens the file with external app and sync the changes back to the server. It will help users to edit files that are enclosed inside the scoped storage.

Enhancement - Biometrical protection enabled just after passcode/pattern: #3539

Before: Pattern/Passcode were enabled first, and then, biometrical protection in Settings in a different step

2.20: After entering correct passcode/pattern, a dialog will ask the user if he/she wants to additionally enable the biometrical lock:

Screenshot 2022-02-07 at 12 52 55

Enhancement - Logs enabled by default in debug variant: #3526

Before: Logging feature disabled by default. User must enable it manually.

2.20: Logging feature is enabled by default if the app is built with debug variant.

Let me (or anyone in the team) know any question, issue or comment about this stuff.

2.21 Release

Features to include in the release. You can find the changelog here

I will briefly comment the enhancements. I guess bugfixes does not have nothing to do with documentation (let me know if i'm wrong)

Secure connections

Before: for servers under http://, it was not mandatory to type the http:// prefix in the URL

2.21: for servers under http://, it is mandatory to type the http:// prefix, because the new default is https://. Otherwise, a SSL initialization error will raise

Release Notes

Before: After upgrading to new version, update wizard was displayed in case something important should be notified to the users

2.21: After every release, a list of new features, improvements and fixes will bu displayed to inform users about news. The list of news will be always available in Settings to recheck.

image (2)

Support for SVG files

Before: SVG files were not previewed inside the app

2.21: SVG files previewed inside the app

Downloads in Details view

Before: Thumbnail in Details view did nothing

2.21: Thumbnail in Details view triggers file download

Hidden files

Before: Hidden files were always listed

2.21: A new option in Settings will let users decide whether hidden files are listed or not.

Send with multiselection

Before: Send operation could only be done over one file

2.21: Send operation allows to attach more than one file

New option to prevent screenshots (Enterprise)

Before: Login view, Passcode view and Pattern Lock view were prevented from taking screenshots because security reasons. Any other view allowed to take screenshots.

2.21: A new option called allow_screenshots will let enterprise users decide if the whole app or only the security views are prevented from taking screenshots. Default: true (as behaviour before)

Let me (or anyone in the team) know any question, issue or comment about this stuff.

CC @mmattel

Release notes are far out of date

After a discussion with @jesmrec we identified, that the android doc release notes https://github.com/owncloud/docs-client-android/blob/master/modules/ROOT/pages/appendices/release_notes.adoc have not been maintained post the release of 2.10 - at the moment we are shipping 2.18.x

Referencing the changelog available at https://github.com/owncloud/android/tree/master/changelog, the release notes are present for 2.18.x but nothing lower.

  1. Drop the release notes in docs completely
  2. Only add the available ones from the changelog file, creates a missing delta
  3. Try to recover the missing changelog info and provide it to docs so we can add it
  4. ...

Suggestions welcomed

Note, in case we keep the docs android release notes, it may be a good idea to add an item at https://github.com/owncloud/android/blob/master/.github/ISSUE_TEMPLATE/release_template.md that the changelog delta should be transferred to docs - an issue would be sufficient

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.