Apply suggestions from code review

Co-authored-by: Phil Davis <phil@jankaritech.com>
This commit is contained in:
Willy Kloucek
2020-12-01 20:38:02 +01:00
committed by GitHub
parent 1689f744a4
commit c67012d880
4 changed files with 9 additions and 6 deletions

View File

@@ -6,4 +6,4 @@ geekdocEditPath: edit/master/docs/extensions/proxy
geekdocFilePath: _index.md
---
This service provides an proxy service that routes requests to the correct extensions.
This service provides a proxy service that routes requests to the correct extensions.

View File

@@ -25,6 +25,7 @@ cd ocis
The oCIS binary source is in the `ocis` folder inside the oCIS repository. In this folder you can build the oCIS binary:
{{< highlight txt >}}
cd ocis
make generate
make build
{{< / highlight >}}

View File

@@ -35,11 +35,13 @@ You may add flags to your commit message or PR title in order to speed up pipeli
- `[docs-only]`: please add this flag, if you only changed documentation. This will only trigger documentation related CI steps.
- `[tests-only]`: please add this flag, if you only changed tests or test-related tooling. You do not need to add a changelog for tests-only changes.
### Knowledge base
- My pipeline fails because some CI related files or commands are missing.
Please make sure to rebase your branch onto the lastest master of oCIS. It could be that the pipeline definition (`.drone.star`) was changed on the master branch. This is is the only file, that will not be auto merged to master upon pipeline run. So things could be out of sync.
Please make sure to rebase your branch onto the lastest master of oCIS. It could be that the pipeline definition (`.drone.star`) was changed on the master branch. This is the only file, that will not be auto merged to master upon pipeline run. So things could be out of sync.
- How can I see the YAML drone pipeline definition?

View File

@@ -12,9 +12,9 @@ geekdocFilePath: getting-started.md
## Requirements
We want contribution to oCIS and the creation of extensions to be as easy as possible.
So we are trying to reflect this the used tooling. It should be kept simple and quick to be set up.
So we are trying to reflect this in the tooling. It should be kept simple and quick to be set up.
Besides of standard development tools like git and a text editor, you need following software for development:
Besides standard development tools like git and a text editor, you need the following software for development:
- Go >= v1.13 ([install instructions](https://golang.org/doc/install))
- Yarn ([install instructions](https://classic.yarnpkg.com/en/docs/install))
@@ -41,7 +41,7 @@ The `scripts` folder contains scripts to perform various build, install, analysi
## Starting points
Depending on what you want do develop there are different starting points. These will be described below.
Depending on what you want to develop there are different starting points. These will be described below.
### Developing oCIS
@@ -49,7 +49,7 @@ If you want to contribute to oCIS:
- see [contribution guidelines](https://github.com/owncloud/ocis#contributing)
- make sure the tooling is set up by [building oCIS]({{< relref "build.md" >}}) and [building the docs]({{< relref "build-docs.md" >}})
- create or pick an [open issue](https://github.com/owncloud/ocis/issues) to develop on
- create or pick an [open issue](https://github.com/owncloud/ocis/issues) to develop on and mention in the issue that you are working on it
- open a PR and get things done
### Developing extensions