Code Monkey home page Code Monkey logo

docs-client-ios-app's Introduction

iOS App Documentation

Table of Contents

Building the iOS Docs

The iOS App documentation is not built independently. Instead, it is built together with the main documentation. However, you can build a local copy of the iOS App 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 iOS App for more information.

Create a New Version Branch for the iOS App

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

docs-client-ios-app's People

Contributors

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

Stargazers

 avatar  avatar

Watchers

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

Forkers

stjordanis d7oc

docs-client-ios-app's Issues

Release 11.9.0

The iOS app gets soon an update to version 11.9.0 with the following Github tag: v11.9.0

Please prepare the docs repo for the new release.

Release 12.1

The iOS app got an update to version 12.1 with the following Github tag: v12.1

Please prepare the docs repo for the new release.

iOS: Feature "Shortcuts"

WHAT Needs to be Documented?

The iOS feature Shortcuts Actions need to be documented:
owncloud/ios-app#491
owncloud/ios-app#930

WHERE Does This Need To Be Documented (Link)?

WHY Should This Change Be Made?

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

Enable CI

This repo has been prepared for production.
It is necessary to enable CI.
A check is necessary if all settings in .drone.star in master and 11.7 are setup correctly

Some Q & A

Interesting for documentation, some Q&A about behaviour details of the iOS app:

Q:

While documenting the iOS app settings -> "Media upload": What does "keep media file names" mean? What happens to filenames if I deactivate it?

A:

  • keep media file names ON: media files will have in ownCloud the name they have in the iOS system. Like IMG_2222.heic or VID_2222.mov
  • keep media files names OFF : media files with longer name Photo-<date>_<seq_number>.heic

Q:

when trying to logout I open the sidebar and tap on the eject icon right to my username. My understanding was that this is the action to log me out. But I still have access to my files. So I swiped over my username and a red "log out" button appears which seems to log me out really. Is this the correct behaviour? If so, could you explain to me why there is this intermediate action with the eject icon?

A:

Tapping the eject button closes/disconnects an active connection. "Delete"ing (by swipe, called "Log out" in branded version) removes the connection.

Similar to closing an open document (you no longer see the contents, but you can open it again) vs. deleting a document (the document is gone).
The eject button is a UI pattern used for over a decade on macOS for network drives and IIRC now also used in the iOS Files app for connections to SMB/Window shares.

[iOS] Explain cert monitoring for accounts in the iOS app

WHAT Needs to be Documented?

iOS app warns users users about significant changes in SSL certificates.
(see information in internal discussion: https://github.com/owncloud/enterprise/issues/4558#issuecomment-839661932)

WHERE Does This Need To Be Documented (Link)?

https://doc.owncloud.com/ios-app/ios_security.html#ssltls-certificates

WHY Should This Change Be Made?

Current docs only cover cert check for new accounts, not changes

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

Release 11.11.0

The iOS app gets soon an update to version 11.11.0 with the following Github tag: v11.11.0

Please prepare the docs repo for the new release.

Missing the descripton of "Enable diagnostics"

We are writing the iOS Documentation/Tutorials for an customer and stumbled over the point in advanced Settings "active diagnostics" (in German "Diagnose aktivieren" see screenshot) Release Version 12.0.3 build 1550

Bildschirmfoto 2023-11-28 um 13 08 56

I didn't find anything about this point in the docs.

Please tell me, what this point is for and whats happens if it is enabled.

Build options missing in the documentation

mdm_tables.adoc also contains auto-generated documentation on available build flags that are available for branding. At the moment, this part of the documentation is not publicly visible and therefore inaccessible.

A new appendix should be added, covering the available build options for use in the Branding.plist file:

# Build options

== Introduction

The following build options are available for configuring custom builds via the `Branding.plist` file: 

include::./mdm_tables.adoc[tag=build]

If this should not be part of the documentation, I'd like to bring back doc/BUILD_CUSTOMIZATION.md to the owncloud/ios-app repository in its entirety to cover the gaps in documentation.

MDM - Licensing has a dummy text - needs fixing

The MDM Licencing text needs proper content. Found by chance, currently it is:

=== Licensing

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus orci lorem, sagittis at mollis non, consequat a purus. Integer vestibulum luctus est id faucibus. Etiam euismod posuere tristique.

include::{mdm-base-url}{mdm-tag-name}{mdm-file-url}[tag=licensing]

@michaelstingl @hosy @felix-schwarz any suggestions?

iOS: Feature "Local Account Search"

WHAT Needs to be Documented?

The new iOS feature Local Account Search need to be documented.
In the PR you can get the current state of possible search terms and keywords and who it works:
owncloud/ios-app#933

WHERE Does This Need To Be Documented (Link)?

WHY Should This Change Be Made?

(Optional) What Type Of Content Change Is This?

  • New Content Addition
  • Old Content Deprecation
  • Existing Content Simplification
  • Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

  • Admin Manual
  • Developer Manual
  • User Manual
  • Android
  • iOS
  • Branded Clients
  • Desktop Client
  • Other

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.