Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,11 @@ GRAPH_USERNAME_MATCH=none
OC_EXCLUDE_RUN_SERVICES=idp
```

Look [here](./10-external-idp.md#opencloud-configuration) for some more details about these settings.
Look [here](./external-idp.md#opencloud-configuration) for some more details about these settings.

## Client Configuration

The [OIDC clients](./10-external-idp.md#client-configuration) required by OpenCloud are pre-configured in the Docker Compose setup and match the clients used by the built-in IdP.
The [OIDC clients](./external-idp.md#client-configuration) required by OpenCloud are pre-configured in the Docker Compose setup and match the clients used by the built-in IdP.

## Advanced Configuration

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,4 +77,4 @@ Login with your browser:

If you encounter any issues or errors, try finding a solution here:

- [Common Issues & Help](../../50-resources/30-common-issues.md)
- [Common Issues & Help](../../resources/common-issues.md)
Original file line number Diff line number Diff line change
Expand Up @@ -82,5 +82,5 @@ Your OpenCloud server is now running and ready to use 🚀

If you encounter any issues or errors, try finding a solution here:

- [Common Issues & Help](./../../50-resources/30-common-issues.md)
- [Common Issues & Help](./../../resources/common-issues.md)

Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ Login with:
<img src={require("./../img/docker-compose/login.png").default} alt="Admin general" width="1920"/>

## Troubleshooting
If you encounter any issues, check the [Common Issues & Help](./../../50-resources/30-common-issues.md)
If you encounter any issues, check the [Common Issues & Help](./../../resources/common-issues.md)

---

Original file line number Diff line number Diff line change
Expand Up @@ -98,4 +98,4 @@ Your OpenCloud server is now running and ready to use 🚀

If you encounter any issues or errors, try finding a solution here:

- [Common Issues & Help](./../../50-resources/30-common-issues.md)
- [Common Issues & Help](./../../resources/common-issues.md)
Original file line number Diff line number Diff line change
Expand Up @@ -107,4 +107,4 @@ Your OpenCloud server is now running and ready to use 🚀
---

### If you encounter any issues or errors, try finding a solution here:
- [Common Issues & Help](./../../50-resources/30-common-issues.md)
- [Common Issues & Help](./../../resources/common-issues.md)
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: "🔄 Keep your setup up to date with the latest features!"
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'

This guide provides steps to upgrade OpenCloud for both [docker](docs/admin/20-getting-started/20-docker/30-docker.md) and [docker compose](docs/admin/20-getting-started/20-docker/20-docker-compose.md)
This guide provides steps to upgrade OpenCloud for both [docker](docs/admin/getting-started/docker/docker.md) and [docker compose](docs/admin/getting-started/docker/docker-compose.md)

### 1. Stop OpenCloud

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Below, you’ll find details about each user, including their roles and login cr
#### Role: Admin
📌 **Co-developer of UNIX & inventor of the C programming language**

<img src={require("./img/40-demo-user/dennis-ritchie.png").default} alt="Dennis Ritchie" width="200"/>
<img src={require("./img/demo-user/dennis-ritchie.png").default} alt="Dennis Ritchie" width="200"/>

- Studied physics and applied mathematics at Harvard University
- Worked at Bell Labs from 1967, where he developed the first version of the Unix operating system
Expand All @@ -40,7 +40,7 @@ Below, you’ll find details about each user, including their roles and login cr
#### Role: Space Admin
📌 **Software pioneer & NASA developer**

<img src={require("./img/40-demo-user/margaret-hamilton.png").default} alt="Margaret Hamilton" width="200"/>
<img src={require("./img/demo-user/margaret-hamilton.png").default} alt="Margaret Hamilton" width="200"/>

- Studied mathematics at Earlham College
- Developed the on-board flight software for NASA as a software engineer at MIT
Expand All @@ -53,7 +53,7 @@ Below, you’ll find details about each user, including their roles and login cr
#### Role: User
📌 **Father of modern computer science & codebreaker in the Second World War**

<img src={require("./img/40-demo-user/alan-turing.png").default} alt="Alan Turing" width="200"/>
<img src={require("./img/demo-user/alan-turing.png").default} alt="Alan Turing" width="200"/>

- British logician, mathematician, and computer scientist
- Developed the theoretical foundations of modern computer technology
Expand All @@ -66,7 +66,7 @@ Below, you’ll find details about each user, including their roles and login cr
#### Role: User
📌 Computer scientist & microchip design pioneer

<img src={require("./img/40-demo-user/lynn-conway.png").default} alt="Lynn Conway" width="200"/>
<img src={require("./img/demo-user/lynn-conway.png").default} alt="Lynn Conway" width="200"/>

- Studied electrical engineering at Columbia University
- Developed VLSI design methodology, revolutionizing microchip development
Expand All @@ -81,7 +81,7 @@ Below, you’ll find details about each user, including their roles and login cr
#### Role: User
📌 **First woman with a PhD in computer science**

<img src={require("./img/40-demo-user/mary-kenneth-keller.png").default} alt="Mary Kenneth Keller" width="200"/>
<img src={require("./img/demo-user/mary-kenneth-keller.png").default} alt="Mary Kenneth Keller" width="200"/>

- Was a nun and studied mathematics (Bachelor & Master of Science)
- First woman to work at Dartmouth College's Computer Science Center
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Web",
"position": 2
"position": 3
}
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ for a suitable one and open a pull request!
To make sure your pull request can be efficiently reviewed and won't need a lot of changes down the road, please run the linter and
the unit tests via `pnpm lint --fix` and `pnpm test:unit` locally. Our [CI](https://drone.opencloud.eu/opencloud/web) will run on
pull requests and report back any problems after that. For a further introduction on how we handle testing, please head to
the [testing docs](./../30-testing/10-running-tests.md).
the [testing docs](./../testing/running-tests.md).


## Code Conventions
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ From a developer's perspective, the most important parts of the [OpenCloud Web r

The `/dev` folder contains all the configuration files that are needed in the `docker-compose.yml` file. This docker compose stack
contains all the backend and testing related infrastructure that is needed for an out-of-the-box usable localhost development setup,
as described in the [tooling section](./../20-development/30-tooling.md).
as described in the [tooling section](./../development/tooling.md).

### packages Folder

Expand All @@ -29,7 +29,7 @@ Having these packages side by side within the `/packages` folder of the repo is
We're using [Playwright](https://playwright.dev) for UI testing. The UI tests are located in `/tests/e2e`.

You're more than welcome to make a pull request and adjust this section of the docs accordingly. :-)
You can read more about testing in our [testing section](./../30-testing/10-running-tests.md)
You can read more about testing in our [testing section](./../testing/running-tests.md)

### package.json File

Expand All @@ -39,7 +39,7 @@ Each package in `/packages` can and most likely will contain another `package.js
### vite.config.ts

We're working with [Vite](https://vitejs.dev) as a local development server and build tool. `vite.config.ts` is the main configuration file for that.
You can read more about the usage in our [tooling section](./../20-development/30-tooling.md).
You can read more about the usage in our [tooling section](./../development/tooling.md).

## (Published) Packages

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ By defining an application via `defineWebApplication` you can provide the follow
- `routes` - the routes to the different views of your application. May be referenced within the `navItems`. Authentication requirements can be defined per item.
- `extensions` - the extensions to be registered in the extension registry. For more details see the `Extensions` section below.

If you want to learn how to implement an app for viewing and editing specific file types, please consult the [relevant documentation](./10-viewer-editor-apps.md) for detailed instructions and guidance.
If you want to learn how to implement an app for viewing and editing specific file types, please consult the [relevant documentation](./viewer-editor-apps.md) for detailed instructions and guidance.

To learn how to integrate an app into OpenCloud Web, please refer to the "Web Apps" section of the Web service docs ("Services" > "Web").

Expand All @@ -106,15 +106,15 @@ and most prominently also in the `files` app we have defined some extension poin
For building an extension you can choose from the types predefined by the OpenCloud Web extension system. See the full list of available extension types below.

1. `ActionExtension` (type `action`) - An extension that can register `Action` items which then get shown in various places (e.g. context menus, batch actions), depending on the
extension points referenced in the extension respectively. Most commonly used for file and folder actions (e.g. copy, rename, delete, etc.). For details, please refer to the [action docs](./20-extension-types/10-action-extensions.md)
2. `SearchExtension` (type `search`) - An extension that can register additional search providers. For details, please refer to the [search docs](./20-extension-types/70-search-extensions.md).
extension points referenced in the extension respectively. Most commonly used for file and folder actions (e.g. copy, rename, delete, etc.). For details, please refer to the [action docs](./extension-types/action-extensions.md)
2. `SearchExtension` (type `search`) - An extension that can register additional search providers. For details, please refer to the [search docs](./extension-types/search-extensions.md).
3. `SidebarNavExtension` (type `sidebarNav`) - An extension that can register additional navigation items for the left sidebar. These can be scoped to specific apps, and programmatically enabled/disabled.
For details, please refer to the [sidebar nav docs](./20-extension-types/50-left-sidebar-menu-item-extensions.md).
4. `SidebarPanelExtension`, (type `sidebarPanel`) - An extension that can register panels for the right sidebar. For details, please refer to the [sidebar panel docs](./20-extension-types/60-right-sidebar-panel-extensions.md).
For details, please refer to the [sidebar nav docs](./extension-types/left-sidebar-menu-item-extensions.md).
4. `SidebarPanelExtension`, (type `sidebarPanel`) - An extension that can register panels for the right sidebar. For details, please refer to the [sidebar panel docs](./extension-types/right-sidebar-panel-extensions.md).
5. `FolderViewExtension` (type `folderView`) - An extension that can register additional ways of displaying the content of a folder (resources like spaces, folders or files) to the user.
For details, please refer to the [folder view docs](./20-extension-types/40-folder-view-extensions.md).
For details, please refer to the [folder view docs](./extension-types/folder-view-extensions.md).
6. `CustomComponentExtension` (type `customComponent`) - An extension that can register a custom component for a render target. For details, please refer to the
[custom component docs](./20-extension-types/30-custom-component-extensions.md)
[custom component docs](./extension-types/custom-component-extensions.md)

You're free to introduce your own extension types within your application code and use the extension registry to query the available ones. However, if you have the impression
that an important extension type is missing and would be beneficial for the platform, please reach out to us by opening a [GitHub issue](https://github.com/opencloud-eu/web/issues/new/choose).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Then, you can start the server by running `docker-compose up opencloud` and acce

The bundled frontend code automatically gets mounted into the Docker containers, recompiles on changes and you can log in using the demo user (admin/admin) and take a look around!

For more details on how to set up Web for development, please see [tooling](./20-development/30-tooling.md).
For more details on how to set up Web for development, please see [tooling](./development/tooling.md).

## Source Code

Expand Down
2 changes: 1 addition & 1 deletion docs/dev/20-web/index.md → docs/dev/web/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ title: 'Web UI'
---

This is the next generation OpenCloud frontend.
If you're new here, head over to the the [getting started guide](./10-getting-started.md) for a quick introduction.
If you're new here, head over to the the [getting started guide](./getting-started.md) for a quick introduction.
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ which makes it easy to write tests, debug them and have them run cross-browser w

#### Preparation

Please make sure you have installed all dependencies and started the server(s) as described in [tooling](./../20-development/30-tooling.md).
Please make sure you have installed all dependencies and started the server(s) as described in [tooling](./../development/tooling.md).

#### Prepare & Start Web

Expand Down