sevenhill/QSfera
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Revert "run remark linter locally"

Browse Source 
This reverts commit 97c348f1ae.
This commit is contained in:
A.Unger
2020-09-23 11:48:59 +02:00
parent 97c348f1ae
commit 8b9e02ec0b
447 changed files with 6088 additions and 6178 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/ocis/extensions.md
+62 -65
View File
@@ -1,14 +1,13 @@
* * *
---
title: "Extension"
date: 2020-02-27T20:35:00+01:00
weight: 40
geekdocRepo: <https://github.com/owncloud/ocis>
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs
geekdocFilePath: extensions.md
---
## geekdocFilePath: extensions.md
{{&lt; toc >}}
{{< toc >}}
## How to build and run ocis-simple
@@ -18,7 +17,7 @@ ocis uses build tags to build different flavors of the binary. In order to work
mkdir ocis-extension-workshop && ocis-extension-workshop
```
Following <https://github.com/owncloud/ocis>
Following https://github.com/owncloud/ocis
```console
git clone https://github.com/owncloud/ocis.git
@@ -27,20 +26,20 @@ cd ocis
TAGS=simple make generate build
```
_Q: Can you specify which version of phoenix to use?_
_A: No, the phoenix that is used is compiled into the [assets of ocis-phoenix](https://github.com/owncloud/ocis-phoenix/blob/master/pkg/assets/embed.go) which is currently not automatically updated. We'll see how to use a custom phoenix later._
*Q: Can you specify which version of phoenix to use?*
*A: No, the phoenix that is used is compiled into the [assets of ocis-phoenix](https://github.com/owncloud/ocis-phoenix/blob/master/pkg/assets/embed.go) which is currently not automatically updated. We'll see how to use a custom phoenix later.*
`bin/ocis server`
Open the browser at http&#x3A;//localhost:9100
Open the browser at http://localhost:9100
1. You land on the login screen. click login
2. You are redirected to an idp at http&#x3A;//localhost:9140/oauth2/auth with a login mask. Use `einstein:relativity`to login (one of the three demo users)
3. You are redirected to http&#x3A;//localhost:9100/#/hello the ocis-hello app
4. Replace `World` with something else and submit. You should see `Hello %something else%`
1. You land on the login screen. click login
2. You are redirected to an idp at http://localhost:9140/oauth2/auth with a login mask. Use `einstein:relativity`to login (one of the three demo users)
3. You are redirected to http://localhost:9100/#/hello the ocis-hello app
4. Replace `World` with something else and submit. You should see `Hello %something else%`
_Q: One of the required ports is already in use. Ocis seems to be trying to restart the service over and over. What gives?_
_A: Using the ocis binary to start the server will case ocis to keep track of the different services and restart them in case they crash._
*Q: One of the required ports is already in use. Ocis seems to be trying to restart the service over and over. What gives?*
*A: Using the ocis binary to start the server will case ocis to keep track of the different services and restart them in case they crash.*
## Hacking ocis-hello
@@ -50,25 +49,25 @@ go back to the ocis-extension-workshop folder
cd ..
```
Following <https://github.com/owncloud/ocis-hello>
Following https://github.com/owncloud/ocis-hello
git clone https://github.com/owncloud/ocis-hello.git
cd ocis-hello
```
git clone https://github.com/owncloud/ocis-hello.git
cd ocis-hello
yarn install
# this actually creates the assets
yarn build
yarn install
# this actually creates the assets
yarn build
# this will compile the assets into the binary
make generate build
# this will compile the assets into the binary
make generate build
```
Two options:
1. run only the necessery services from ocis and ocis-hello independently
2. compile ocis with the updated ocis-hello
1. run only the necessery services from ocis and ocis-hello independently
2. compile ocis with the updated ocis-hello
### Option 1:
get a list of ocis services:
```console
@@ -83,10 +82,12 @@ In order to be able to manage the processes ourselves we need to start them inde
`bin/ocis server` starts the same services as:
bin/ocis micro &
bin/ocis phoenix &
bin/ocis hello &
bin/ocis reva &
```
bin/ocis micro &
bin/ocis phoenix &
bin/ocis hello &
bin/ocis reva &
```
Now we can kill the `ocis hello` and use our custom built ocis-hello binary:
@@ -97,13 +98,15 @@ bin/ocis-hello server
## Hacking phoenix (and ocis-phoenix)
Following <https://github.com/owncloud/phoenix> we are going to build the current phoenix
Following https://github.com/owncloud/phoenix we are going to build the current phoenix
git clone https://github.com/owncloud/phoenix.git
cd phoenix
```
git clone https://github.com/owncloud/phoenix.git
cd phoenix
yarn install
yarn dist
yarn install
yarn dist
```
We can tell ocis to use the compiled assets:
@@ -118,7 +121,7 @@ PHOENIX_ASSET_PATH="`pwd`/../phoenix/dist" bin/ocis phoenix
The owncloud design system contains a set of ownCloud vue components for phoenix or your own ocis extensions. Use it for a consistent look and feel.
Point your browser to <https://owncloud.github.io/owncloud-design-system> and check the available components. Live editing the examples in the browser is supported.
Point your browser to https://owncloud.github.io/owncloud-design-system and check the available components. Live editing the examples in the browser is supported.
note: There is a bug with navigation sub items: either click a nav item twice or refresh the page
@@ -126,10 +129,10 @@ note: There is a bug with navigation sub items: either click a nav item twice or
This is what hello is: copy and extend!
1. Phoenix is configured using the config.json which is served by the phoenix service (either `bin/ocis phoenix` or `bin/ocis-phoenix server`)
1. Phoenix is configured using the config.json which is served by the phoenix service (either `bin/ocis phoenix` or `bin/ocis-phoenix server`)
2. point ocis phoenix to the web config which you extended with an external app:
`PHOENIX_WEB_CONFIG="`pwd`/../phoenix/config.json" PHOENIX_ASSET_PATH="`pwd`/../phoenix/dist" bin/ocis phoenix`
2. point ocis phoenix to the web config which you extended with an external app:
`PHOENIX_WEB_CONFIG="`pwd`/../phoenix/config.json" PHOENIX_ASSET_PATH="`pwd`/../phoenix/dist" bin/ocis phoenix`
```json
{
@@ -166,26 +169,23 @@ This is what hello is: copy and extend!
## Phoenix extension points
{{&lt; hint info >}}
{{< hint info >}}
For an up to date list check out [the phoenix documentation](https://github.com/owncloud/phoenix/issues/2423).
{{&lt; /hint >}}
{{< /hint >}}
Several ones available:
### Phoenix core
- App switcher (defined in config.json)
- App container (loads UI of your extension)
- App switcher (defined in config.json)
- App container (loads UI of your extension)
### Files app
- File action
- Create new file action
- Sidebar
- Quick access for sidebar inside of file actions (in the file row)
- File action
- Create new file action
- Sidebar
- Quick access for sidebar inside of file actions (in the file row)
Example of a file action in the `app.js`:
```js
const appInfo = {
name: 'MarkdownEditor',
@@ -221,20 +221,17 @@ Short answer: any way you like
Long answer: micro and ocis-hello follow a protocol driven development:
- specify the API using protobuf
- specify the API using protobuf
- generate client and server code
- evolve based on the protocol
- generate client and server code
- CS3 api uses protobuf as well and uses GRPC
- evolve based on the protocol
- ocis uses go-micro, which provides http and grpc gateways
- the gateways and protocols are optional
- CS3 api uses protobuf as well and uses GRPC
- owncloud and kopano are looking into a [MS graph](https://developer.microsoft.com/de-de/graph) like api to handle phoenix requests.
- they might be about user, contacrs, calendars ... which is covered by the graph api
- we want to integrate with eg. kopano and provide a commen api (file sync and share is covered as well)
- ocis uses go-micro, which provides http and grpc gateways
- the gateways and protocols are optional
- owncloud and kopano are looking into a [MS graph](https://developer.microsoft.com/de-de/graph) like api to handle phoenix requests.
- they might be about user, contacrs, calendars ... which is covered by the graph api
- we want to integrate with eg. kopano and provide a commen api (file sync and share is covered as well)
- as an example for protobuf take a look at [ocis-hello](https://github.com/owncloud/ocis-hello/tree/master/pkg/proto/v0)
- as an example for protobuf take a look at [ocis-hello](https://github.com/owncloud/ocis-hello/tree/master/pkg/proto/v0)