Skip to content

Commit 4df038b

Browse files
authored
modify and add index.md for each sectionin user docs for better under… (#728)
* modify and add index.md for each sectionin user docs for better understanding and look and feel. Check links and fix wrong * add .md to the links so they can be resolved * remove german translation in sidebar
1 parent b72dcfc commit 4df038b

40 files changed

Lines changed: 679 additions & 220 deletions

File tree

docs/user/admin/_category_.json

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22
"label": "Administration of OpenCloud",
33
"position": 9,
44
"link": {
5-
"type": "generated-index",
6-
"description": "Tutorials for administrating your OpenCloud.",
7-
"slug": "user/admin/"
5+
"type": "doc",
6+
"id": "admin-overview"
87
}
98
}

docs/user/admin/index.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
sidebar_position: 0
3+
id: admin-overview
4+
title: Administration of OpenCloud
5+
---
6+
7+
# Administration of OpenCloud
8+
9+
This section explains the administration features available in OpenCloud. Depending on your permissions, you can manage account settings, administer users, groups, and spaces, create app tokens, and connect external tools such as WebDAV clients.
10+
11+
## In this section
12+
13+
- [Settings](./settings.md)
14+
View the administration area and manage users, groups, and spaces, depending on your permissions.
15+
16+
- [App Tokens](./app-tokens.md)
17+
Create and manage secure tokens for third-party applications and WebDAV clients.
18+
19+
- [WebDAV](./web-dav.md)
20+
Connect OpenCloud files and spaces to your operating system or file manager using WebDAV.
Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
{
22
"label": "OpenCloud Android App",
3-
"position": 8
3+
"position": 8,
4+
"link": {
5+
"type": "doc",
6+
"id": "android-app-overview"
7+
}
48
}

docs/user/android-app/index.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11
---
2+
sidebar_position: 0
3+
id: android-app-overview
24
title: OpenCloud Android App
35
---
46

5-
import DocCardList from '@theme/DocCardList';
7+
# OpenCloud Android App
68

7-
The OpenCloud Android app provides mobile access to OpenCloud on Android devices.
8-
It offers essential functions for working on the go, including file management, uploads, and quick collaboration.
9+
The OpenCloud Android app provides mobile access to your files, spaces, and shares. It is designed for quick access on the go, with support for setup, search, shortcuts, and file management.
910

10-
#### Key Features
11+
## What you will find here
1112

12-
- File management: view, upload, share, and organize files and folders
13-
- Access to spaces and their stored content
14-
- Full-text and metadata search for quickly finding documents
15-
- Support for collaborative editing via Web Office
16-
- Real-time synchronization of changes
17-
18-
Use Case: Ideal for users who need mobile access to their OpenCloud data and want to handle essential tasks while on the go.
19-
20-
<DocCardList />
13+
- [General](./general/) - Install the app, set it up, and learn the main interface and settings.
14+
- [Files and folders](./files-and-folders/) - Create and edit content, upload files, and make items available offline.
15+
- [Spaces](./spaces.md) - Work with Spaces and their available actions on Android.
16+
- [Search](./search.md) - Find files and folders from within the Android app.
17+
- [Shortcuts](./shortcuts.md) - Create shortcuts to files or web links.
18+
- [Shares](./shares/) - Invite people and create share links from the Android app.
Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
{
22
"label": "OpenCloud Desktop",
3-
"position": 6
3+
"position": 6,
4+
"link": {
5+
"type": "doc",
6+
"id": "desktop-client-overview"
7+
}
48
}

docs/user/desktop-client/index.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,23 @@
11
---
2+
sidebar_position: 0
3+
id: desktop-client-overview
24
title: OpenCloud Desktop Client
35
---
46

5-
import DocCardList from '@theme/DocCardList';
7+
# OpenCloud Desktop Client
68

7-
The OpenCloud Desktop Client enables file synchronization between a local computer and OpenCloud.
8-
It ensures that files are available offline and that changes are automatically synchronized once an internet connection is restored.
9-
The client is available for Windows, macOS, and Linux.
9+
The OpenCloud Desktop Client synchronizes files between your computer and OpenCloud. It is available for Windows, macOS, and Linux and provides offline access, automatic synchronization, and a consistent way to work with files locally.
1010

11-
#### Key Features
11+
## In this section
1212

13-
- Synchronization of files and folders between desktop or laptop computer and OpenCloud
14-
- Automatic updates when changes occur
15-
- Offline access to important data
13+
- [Windows](./windows/installation.md)
14+
Install, set up, and configure the Desktop Client on Windows.
1615

17-
<DocCardList />
16+
- [macOS](./macos/installation.md)
17+
Install, set up, and configure the Desktop Client on macOS.
18+
19+
- [Linux](./linux/installation.md)
20+
Install, set up, and configure the Desktop Client on Linux.
21+
22+
- [Common functionality](./common-functionality/multiple-accounts.md)
23+
Learn about shared features such as multiple accounts, file naming rules, conflict handling, and logging.

docs/user/files-and-folders/_category_.json

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22
"label": "Manage Files and Folders",
33
"position": 3,
44
"link": {
5-
"type": "generated-index",
6-
"description": "Tutorials for managing your files and folders.",
7-
"slug": "user/files-and-folders/"
5+
"type": "doc",
6+
"id": "files-and-folders-overview"
87
}
98
}
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
sidebar_position: 0
3+
id: files-and-folders-overview
4+
title: Manage Files and Folders
5+
---
6+
7+
# Manage Files and Folders
8+
9+
Learn how to organize, manage, and review files and folders in OpenCloud.
10+
This section covers common day-to-day tasks such as creating and moving content, uploading files, restoring deleted items, and reviewing file history.
11+
12+
## In this section
13+
14+
### Organize and manage content
15+
16+
- [Create, rename, and move files and folders](./create-rename-move.md)
17+
Create new content, reorganize existing files and folders, and move items to a different location.
18+
19+
- [Upload, download, and unzip content](./upload-download-unzip.md)
20+
Upload files to OpenCloud, download them to your device, or extract ZIP archives.
21+
22+
- [Delete and restore items from the trash](./delete-restore.md)
23+
Remove files and folders and restore them later if needed.
24+
25+
### Find and classify content
26+
27+
- [Search for files and content](./search.md)
28+
Find files by name or search within their content.
29+
30+
- [Add and remove tags](./tags.md)
31+
Use tags to organize files and folders and make them easier to find.
32+
33+
- [Create shortcuts to files or web links](./shortcut.md)
34+
Add shortcuts to frequently used files or external websites for quicker access.
35+
36+
### Review file history and activity
37+
38+
- [View file versions and activity history](./versions.md)
39+
Review earlier file versions and track how a file has changed over time.
40+
41+
- [Inspect file activity](./activity.md)
42+
See which actions were performed on a file or folder and who made the changes.

docs/user/general/index.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,22 @@
22
title: Web User Interface and Navigation
33
---
44

5-
import DocCardList from '@theme/DocCardList';
5+
# Web User Interface and Navigation
66

7-
The Web Client is the primary interface of OpenCloud.
8-
It provides full access through the browser without requiring any additional software installation.
7+
The Web Client is the main interface of OpenCloud and provides full access through the browser without requiring any additional software.
98

10-
#### Key Features
9+
This section explains the main areas of the interface and shows how to navigate the Web Client, adjust the file list, and personalize your account settings.
1110

12-
- File Management: Create, upload, edit, share, and organize files and folders
13-
- Space and User/Group Management
14-
- Collabora Online for real-time collaborative document editing
11+
## In this section
1512

16-
<DocCardList />
13+
- [Overview](./overview.md)
14+
Get familiar with the main areas of the Web Client, including the sidebar, top bar, file list, and action areas.
15+
16+
- [Account Settings](./account-settings.md)
17+
Manage your profile, preferences, avatar, calendar access, GDPR export, and app tokens.
18+
19+
- [Customize the file list](./file-list-adjustments.md)
20+
Adjust how files are displayed, including hidden files, file extensions, pagination, and tile size.
21+
22+
- [View modes](./view-modes.md)
23+
Switch between table, condensed, and tile views to change how the file list is displayed.

docs/user/index.md

Lines changed: 45 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -19,74 +19,77 @@ import OcLogoLilac from '/static/img/oc-logo-lilac.svg';
1919

2020
## Welcome to the OpenCloud knowledge base
2121

22-
Here you will find all the important information to successfully take the first steps in OpenCloud, to be able to solve
23-
technical problems flexibly yourself and to be able to answer frequently asked questions.
22+
This documentation helps you get started with OpenCloud, understand its main features, and find guidance for everyday tasks, administration, and troubleshooting.
2423

2524
## What is OpenCloud?
2625

27-
OpenCloud is the file sharing and collaboration solution of the Heinlein Group.
26+
OpenCloud is a file sharing and collaboration platform developed by the [Heinlein Group](https://www.heinlein.group/). It helps teams store, organize, share, and collaborate on files across different devices and use cases.
2827

29-
Through intelligent file management and a strong open source community, files become valuable resources, effectively structured and usable in the long term. With flexible data rooms and intelligent access rights, teams can access and work together on data anytime, anywhere without barriers, but with a lot of productivity.
28+
You can access OpenCloud in different ways, depending on your workflow:
3029

31-
OpenCloud can be accessed in different ways, depending on the device and use case:
30+
- The [Web Client](./general/) provides full access to OpenCloud features directly in the browser, including file management, collaboration features, and administration options based on your permissions.
31+
- The [Desktop Client](./desktop-client/) synchronizes files between OpenCloud and your local computer for offline work and automatic updates.
32+
- The [iOS App](./ios-app/) provides convenient access to files and essential actions on iPhone and iPad.
33+
- The [Android App](./android-app/) provides convenient access to files and essential actions on Android devices.
34+
- [Collabora in OpenCloud](./collabora) provides browser-based document editing and real-time collaboration for supported office files stored in OpenCloud.
3235

33-
- The ["Web Client"](./general/) provides full access to all OpenCloud features directly in the browser. It allows file management, user and space administration, and online collaboration via Collabora.
36+
Each client and integration is designed for a specific use case: the Web Client for full-featured browser access, the Desktop Client for local synchronization, the mobile apps for mobile access and everyday tasks, and Collabora Online for browser-based document editing and collaboration.
3437

35-
- The ["Desktop Client"](./desktop-client/) synchronizes files between the OpenCloud and a local computer, enabling offline work and automatic updates.
38+
## Administration and deployment
3639

37-
- The Mobile Apps for ["iOS"](./ios-app/) and ["Android"](./android-app/) allow quick access to files and basic management functions while on the go.
40+
If you want to install, set up, or manage your own OpenCloud environment, see the [Admin documentation](../admin/) and the [Getting Started](../admin/getting-started/) section.
3841

39-
Each client is designed for a specific workflow:
40-
the Web Client for full-featured online use, the Desktop Client for local synchronization, and the Mobile Apps for mobile productivity.
42+
## Documentation versions
4143

42-
## How can I use OpenCloud?
44+
This documentation is versioned so you can find the information that matches your OpenCloud version.
4345

44-
Instructions on how to install and set up your own OpenCloud can be found in the ["Admin" Documentation](../admin/) under ["Getting-Started"](../admin/getting-started/)
46+
- **Rolling version**
47+
Reflects the current development state. Changes are added continuously, but some features may not yet be fully documented.
4548

46-
## Documentation Versions
49+
- **Stable release versions**
50+
Provide documentation for officially released versions. These versions are reviewed and remain unchanged after publication.
4751

48-
Our documentation is versioned to ensure you always find the right information for your software version.
52+
You can switch between the Rolling version and specific release versions using the version menu in the top-right corner.
4953

50-
- Rolling Version: Reflects the current development state. Changes are continuously added, but the documentation may be incomplete, as new features might not yet be documented. Ideal if you are using a pre-release or development build.
51-
- Stable Release Versions: Documentation for officially released versions — frozen, reviewed, and unchanged since publication.
54+
## Explore the documentation
5255

53-
You can switch between the Rolling version and specific Release versions using the version menu in the top right corner.
54-
Through intelligent file management and a strong open source community, files become valuable resources — effectively structured and usable in the long term. With flexible data rooms and intelligent access rights, teams can access and work together on data anytime, anywhere without barriers, but with a lot of productivity.
56+
### Apps
5557

56-
## Table of contents
58+
- [OpenCloud Desktop Client](./desktop-client/)
59+
Learn how to install, set up, and use the Desktop Client.
5760

58-
### [User Interface and Navigation](./general/)
61+
- [OpenCloud iOS App](./ios-app/)
62+
Find guidance for using OpenCloud on iPhone and iPad.
5963

60-
Here you will find general information about account settings, customizations and view modes.
64+
- [OpenCloud Android App](./android-app/)
65+
Find guidance for using OpenCloud on Android devices.
6166

62-
### [Manage Files and Folders](./files-and-folders/)
67+
### Web and editing
6368

64-
Here you will find information about the management of files and folders.
69+
- [User Interface and Navigation](./general/)
70+
Learn how to navigate the Web Client, adjust account settings, and customize the interface.
6571

66-
### [Share Files and Folders](./sharing/)
72+
- [Collabora Online](./collabora)
73+
Get an overview of the document editing and collaboration features available through Collabora Online in OpenCloud.
6774

68-
Here you will find information on how to share files and folders.
75+
- [Manage Files and Folders](./files-and-folders/)
76+
Find guidance for creating, organizing, moving, deleting, and restoring files and folders.
6977

70-
### [Working in Teams with Spaces](./spaces/)
78+
- [Share Files and Folders](./sharing/)
79+
Learn how to share content internally, create public links, and use File Drop.
7180

72-
Here you will find information for dealing with Spaces.
81+
- [Working in Teams with Spaces](./spaces/)
82+
Understand how to use Spaces to organize shared work and collaborate with teams.
7383

74-
### [OpenCloud Desktop](./desktop-client/)
84+
### Administration
7585

76-
Here you will find information on how to install and set up the desktop client.
86+
- [Roles](./roles/)
87+
Learn about user roles, Space roles, and share permissions in OpenCloud.
7788

78-
### [OpenCloud iOS App](./ios-app/)
89+
- [Administration of OpenCloud](./admin/)
90+
Explore administration features such as settings, app tokens, and WebDAV access.
7991

80-
Here you will find information about the OpenCloud iOS App.
92+
### Help
8193

82-
### [Roles](./roles/)
83-
84-
Here you will find information about the different roles that can be assigned.
85-
86-
### [Administration of OpenCloud](./admin/)
87-
88-
Here you will find information on what options admins have and how you can use them.
89-
90-
### [Common Issues and Help](./common-issues)
91-
92-
Here you will find information on common issues and help on how to solve them.
94+
- [Common Issues and Help](./common-issues)
95+
Find solutions for common problems and answers to frequently asked questions.

0 commit comments

Comments
 (0)