From 3fd33957caa5350be8d775ed3fd6d776e5a4f66c Mon Sep 17 00:00:00 2001 From: Phil Davis Date: Tue, 3 May 2022 11:01:20 +0545 Subject: [PATCH] Fix docs typos --- CONTRIBUTING.md | 28 ++++++++++----------- docs/architecture/_index.md | 2 +- docs/architecture/efficient-stat-polling.md | 6 ++--- docs/clients/rclone/webdav-sync-oidc.md | 4 +-- docs/extensions/graph/groups.md | 8 +++--- docs/extensions/graph/users.md | 6 ++--- docs/extensions/storage/apps.md | 4 +-- docs/extensions/storage/namespaces.md | 2 +- docs/extensions/storage/spaces.md | 2 +- docs/extensions/storage/terminology.md | 2 +- docs/ocis/adr/0004-support-hot-migration.md | 4 +-- docs/ocis/adr/0007-api-for-spaces.md | 2 +- docs/ocis/adr/0015-events.md | 2 +- docs/ocis/development/getting-started.md | 2 +- 14 files changed, 37 insertions(+), 37 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c494373239a..cb60434d258 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,7 @@ For simplicity reasons, this document mostly refers to the ownCloud [Infinite Sc [I don't want to read this whole thing, I just have a question](#i-dont-want-to-read-this-whole-thing-i-just-have-a-question) [What should I know before I get started](#what-should-i-know-before-i-get-started) -* [ownCloud is hosted on Github](#owncloud-is-hosted-on-github) +* [ownCloud is hosted on GitHub](#owncloud-is-hosted-on-github) * [ownCloud Company, Engineering Partners and Community](#owncloud-company,-engineering-partners-and-community) * [Licensing and CLA](#licensing-and-cla) @@ -42,17 +42,17 @@ We also have a [Rocket Chat Server](https://talk.owncloud.com/channel/ocis) to a ## What should I know before I get started -### ownCloud is hosted on Github +### ownCloud is hosted on GitHub -To effectively contribute to ownCloud Infinite Scale, you need a Github account. You can get that for free at [Github](https://github.com/join). You can find howtos on the internet, for example [here](https://www.wikihow.com/Create-an-Account-on-GitHub). +To effectively contribute to ownCloud Infinite Scale, you need a GitHub account. You can get that for free at [GitHub](https://github.com/join). You can find howtos on the internet, for example [here](https://www.wikihow.com/Create-an-Account-on-GitHub). For other ways of contributing, for example with translations, other systems require you to have an account as well, for example [Transifex](https://www.transifex.com). -The ownCloud project follows the strict Github workflow of development as briefly [described here](https://guides.github.com/introduction/flow/). +The ownCloud project follows the strict GitHub workflow of development as briefly [described here](https://guides.github.com/introduction/flow/). ### ownCloud Company, Engineering Partners and Community -ownCloud Infinite Scale is largely created by developers who are employed by the [ownCloud company](https://www.owncloud.com), which is located in Germany. It is providing support for ownCloud for customers worldwide. In addition there are engineering partners who also work full time on ownCloud related code, for example in [CERN REVA](https://github.com/cs3org/reva/). +ownCloud Infinite Scale is largely created by developers who are employed by the [ownCloud company](https://www.owncloud.com), which is located in Germany. It is providing support for ownCloud for customers worldwide. In addition, there are engineering partners who also work full time on ownCloud related code, for example in [CERN REVA](https://github.com/cs3org/reva/). Because of that fact, the pace that the development is moving forward is sometimes high for people who are not willing and/or able to spend a comparable amount of time to contribute. Even though this can be a challenge, it should not scare anybody away. Here is our clear commitment that we feel honored by everybody who is interested in our work and improves it, no matter how big the contribution might be. @@ -76,7 +76,7 @@ There are many ways to contribute to open source projects, and all are equally v This way to contribute to the project can not be overestimated: People who talk about their experience with ownCloud Infinite Scale and help others with that are the key to success of the project. -There are too many ways of doing that to line them up here, but examples are answering questions in [ownCloud Central](https://central.owncloud.org/) or on [ownCloud Talk](https://talk.owncloud.com/channel/ocis), writing blog posts etc pp. +There are too many ways of doing that to line them up here, but examples are answering questions in [ownCloud Central](https://central.owncloud.org/) or on [ownCloud Talk](https://talk.owncloud.com/channel/ocis), writing blog posts etc. pp. There is no formal guideline to this, just do it :-) @@ -92,7 +92,7 @@ Before creating bug reports, please check [this list](#before-submitting-a-bug-r * **Make sure you are running a recent version** Usually, developers' interest in old versions of software drops very fast once a new shiny version has been released. So the general recommendation is: Use the latest released version or even the current master to reproduce problems that you might encounter. That helps a lot to attract developers attention. * **Determine which [repository](https://github.com/owncloud) the problem should be reported in**. -* **Perform a [cursory search](https://github.com/search?q=+is%3Aissue+user%3Aowncloud)** with possibly a more granular filter on the repository, to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one **if you have new information**. Please abstain from adding "plus ones", except using the Github emojis. That might indicate how many users are affected. +* **Perform a [cursory search](https://github.com/search?q=+is%3Aissue+user%3Aowncloud)** with possibly a more granular filter on the repository, to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one **if you have new information**. Please abstain from adding "plus ones", except using the GitHub emojis. That might indicate how many users are affected. #### How Do I Submit A (Good) Bug Report @@ -126,7 +126,7 @@ Before creating enhancement suggestions, please check [this list](#before-submit #### Before Submitting An Enhancement Suggestion * **Check if there's already an extension or other component which provides that enhancement, even in a different way.** -* **Perform a [cursory search](https://github.com/search?q=+is%3Aissue+user%3Aowncloud)** to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. Feel free to use the Github emojis to indicate that you are in favour of an enhancement request. +* **Perform a [cursory search](https://github.com/search?q=+is%3Aissue+user%3Aowncloud)** to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. Feel free to use the GitHub emojis to indicate that you are in favour of an enhancement request. #### How Do I Submit A (Good) Enhancement Suggestion @@ -152,7 +152,7 @@ To find out how to set up ownCloud Infinite Scale for local development please r ### Pull Requests -All contributions to ownClouds projects use so called pull requests following the [Github PR workflow](https://guides.github.com/introduction/flow/). +All contributions to ownClouds projects use so-called pull requests following the [GitHub PR workflow](https://guides.github.com/introduction/flow/). Please follow these steps to have your contribution considered by the maintainers: @@ -180,7 +180,7 @@ Depending on the ownCloud component, there is complex deployment tooling to inst ## Styleguides -To keep up with a consistent code and tooling landscape, some of the ownCloud modules maintain styleguides for contributions. It is mandatory to follow them in contributions. +To keep up with a consistent code and tooling landscape, some ownCloud modules maintain styleguides for contributions. It is mandatory to follow them in contributions. ### Git Commit Messages @@ -192,7 +192,7 @@ To keep up with a consistent code and tooling landscape, some of the ownCloud mo ### Golang Styleguide -Use the built in golang code formatter before submitting the patch. Also, consulting documentation like [Effective Go](https://golang.org/doc/effective_go) or [Practical Go](http://bit.ly/gcsg-2019) helps to improve the code quality. +Use the built-in golang code formatter before submitting the patch. Also, consulting documentation like [Effective Go](https://golang.org/doc/effective_go) or [Practical Go](http://bit.ly/gcsg-2019) helps to improve the code quality. ### Web Styleguide @@ -216,7 +216,7 @@ The list here contains all the more general categories of issues which are follo #### Platform -Describes the platform the issue is happening on, ie. iOS or Windows. +Describes the platform the issue is happening on, i.e. iOS or Windows. #### Estimation @@ -224,7 +224,7 @@ T-Shirt sizes for effort estimation to fix that bug or implement an enhancement. #### Priority -P1 to P4 (lowest) to indicate an priority. Mostly a tool for internal project management and support. +P1 to P4 (lowest) to indicate a priority. Mostly a tool for internal project management and support. #### QA @@ -260,4 +260,4 @@ Important for browser dependent web issues. It specifies the browser that shows #### Early-Adopter -Tags issues that were reported by one of the oCIS early adopters, ie. customers and users who start using ownCloud Infinite Scale before it's general availability. +Tags issues that were reported by one of the oCIS early adopters, i.e. customers and users who start using ownCloud Infinite Scale before its general availability. diff --git a/docs/architecture/_index.md b/docs/architecture/_index.md index 1e38512c613..093cac155b2 100644 --- a/docs/architecture/_index.md +++ b/docs/architecture/_index.md @@ -7,6 +7,6 @@ geekdocEditPath: edit/master/docs/architecture geekdocFilePath: _index.md --- -In the architecture part of the documentation we collect useful developer documentation on different aspects of the architecture. We are using mermaid.js to collaborate on the necessardy diagrams. +In the architecture part of the documentation we collect useful developer documentation on different aspects of the architecture. We are using mermaid.js to collaborate on the necessary diagrams. *Pictures tell more than a thousand words.* diff --git a/docs/architecture/efficient-stat-polling.md b/docs/architecture/efficient-stat-polling.md index 2fa31fe5c60..efd8ce9d421 100644 --- a/docs/architecture/efficient-stat-polling.md +++ b/docs/architecture/efficient-stat-polling.md @@ -132,7 +132,7 @@ It would require client changes that depend on the server side actually having a But having to list n storages might become a bottleneck anyway, so we are going to have the gateway calculate a virtual root ETag for all entry points a user has access to and cache that. ## Server Side Stat Polling -Every client polls the virtual root ETag (every 30 sec). The gateway will cache the virutal root ETag of every storage for 30 sec as well. That way every storage provider is only stated once every 30 sec (can be throttled dynamically to adapt to storage io load). +Every client polls the virtual root ETag (every 30 sec). The gateway will cache the virtual root ETag of every storage for 30 sec as well. That way every storage provider is only stated once every 30 sec (can be throttled dynamically to adapt to storage io load). {{}} @@ -182,9 +182,9 @@ Since the active clients will poll the etag for all active users the gateway wil For a single machine using a local posix storage the linux kernel already caches the inodes that contain the metadata that is necessary to calculate the ETag (even extended attributes are supported). With 4k inodes 256 nodes take 1Mb of RAM, 1k inodes take 4Mb and 1M inodes take 4Gb to completely cache the file metadata. For distributed filesystems a dedicated cache might make sense to prevent hammering it with stat like requests to calculate ETags. -### Bandwith considerations +### Bandwidth considerations -The bandwith for a single machine might be another bottleneck. Consider a propfind request with roughly 500 bytes and a response with roughly 800 bytes in size: +The bandwidth for a single machine might be another bottleneck. Consider a propfind request with roughly 500 bytes and a response with roughly 800 bytes in size: - At 100Mbit (~10Mb/s) you can receive 20 000 PROPFIND requests - At 1000Mbit (~100Mb/s) you can receive 200 000 PROPFIND requests - At 10Gbit (~1Gb/s) you can receive 2 000 000 PROPFIND requests diff --git a/docs/clients/rclone/webdav-sync-oidc.md b/docs/clients/rclone/webdav-sync-oidc.md index 2360ff97a75..d1d1e250ae9 100644 --- a/docs/clients/rclone/webdav-sync-oidc.md +++ b/docs/clients/rclone/webdav-sync-oidc.md @@ -35,9 +35,9 @@ oidc-gen \ If you have dynamic client registration enabled on your OpenID Connect identity provider, you can skip the `--client-id`, `--client-secret` and `--pub` options. -If your're using a dedicated OpenID Connect client for the OIDC-agent, we recommend a public one with the following two redirect URIs: `http://127.0.0.1:*` and `http://localhost:*`. Alternatively you also may use the already existing OIDC client of the ownCloud Desktop Client (`--client-id=xdXOt13JKxym1B1QcEncf2XDkLAexMBFwiT9j6EfhhHFJhs2KM9jbjTmf8JBXE69` and `--client-secret=UBntmLjC2yYCeHwsyj73Uwo9TAaecAetRwMw0xYcvNL9yRdLSUi0hUAHfvCHFeFh`, no `--pub` set) +If you're using a dedicated OpenID Connect client for the OIDC-agent, we recommend a public one with the following two redirect URIs: `http://127.0.0.1:*` and `http://localhost:*`. Alternatively you also may use the already existing OIDC client of the ownCloud Desktop Client (`--client-id=xdXOt13JKxym1B1QcEncf2XDkLAexMBFwiT9j6EfhhHFJhs2KM9jbjTmf8JBXE69` and `--client-secret=UBntmLjC2yYCeHwsyj73Uwo9TAaecAetRwMw0xYcvNL9yRdLSUi0hUAHfvCHFeFh`, no `--pub` set) -Please also note that the OIDC-agent will listen on your localhost interface on port 12345 for the time of the intial authentication. If that port is already occupied on your machine, you can easily change that by setting the `--redirect-uri` parameter to a different value. +Please also note that the OIDC-agent will listen on your localhost interface on port 12345 for the time of the initial authentication. If that port is already occupied on your machine, you can easily change that by setting the `--redirect-uri` parameter to a different value. After a successful login or an already existing session you will be redirected to success page of the OIDC-agent. You will now be asked for a password for your account configuration, so that your OIDC session is secured and cannot be used by other people with access to your computer. diff --git a/docs/extensions/graph/groups.md b/docs/extensions/graph/groups.md index eef9e9f8d80..145ff82b554 100644 --- a/docs/extensions/graph/groups.md +++ b/docs/extensions/graph/groups.md @@ -21,7 +21,7 @@ The JSON representation of a Group as handled by the Groups API looks like this: } ``` -Our implemenation currently support two Attributes for a Group: +Our implementation currently supports two Attributes for a Group: | Attribute | Description | |---------------|-------------| @@ -33,7 +33,7 @@ Our implemenation currently support two Attributes for a Group: #### `GET /groups` -Returns a list of all groups +Returns a list of all groups Example: @@ -125,7 +125,7 @@ Note the missing `"id"` Attribute. It will be generated by the server: ##### Response -When successful, the Reponse will return the new group including the newly allocated `"id"`: +When successful, the response will return the new group including the newly allocated `"id"`: ``` { @@ -146,7 +146,7 @@ When successful the API returns no response body and the HTTP status code 204 (N #### `PATCH /groups/{id}` -Updating attributes of a single group is supposed to be done with a patch request. This is however currently not fully +Updating attributes of a single group is supposed to be done with a patch request. This is however currently not fully implemented for our write-enabled backends. The PATCH request can however be used to add multiple members to a group at once. See below. diff --git a/docs/extensions/graph/users.md b/docs/extensions/graph/users.md index e7172ea1215..2b5e18dc040 100644 --- a/docs/extensions/graph/users.md +++ b/docs/extensions/graph/users.md @@ -23,7 +23,7 @@ The JSON representation of a User handled by the Users API looks like this: } ``` -Our implemenation currently supports only a limited set of Attributes of Users: +Our implementation currently supports only a limited set of Attributes of Users: | Attribute | Description | |---------------|-------------| @@ -57,7 +57,7 @@ Response: #### `GET /users` -Returns a list of all users +Returns a list of all users Example: @@ -129,7 +129,7 @@ Note the missing `"id"` Attribute. It will be generated by the server: ##### Response -When successful, the Reponse will return the new user, without the password, but including the newly allocated `"id"`: +When successful, the response will return the new user, without the password, but including the newly allocated `"id"`: ``` { diff --git a/docs/extensions/storage/apps.md b/docs/extensions/storage/apps.md index 748e19d9484..93d7b19e774 100644 --- a/docs/extensions/storage/apps.md +++ b/docs/extensions/storage/apps.md @@ -54,7 +54,7 @@ In order to modify the mime type config you need to set `STORAGE_APP_REGISTRY_MI ```json [ { - "mime_type": "applition/vnd.oasis.opendocument.text", + "mime_type": "application/vnd.oasis.opendocument.text", "extension": "odt", "name": "OpenDocument", "description": "OpenDocument text document", @@ -82,7 +82,7 @@ Fields: - `description` is a human readable description of the file / mime type - `icon` URL to an icon which should be used for that mime type - `default_app` name of the default app which opens this mime type when the user doesn't specify one -- `allow_creation` is wether a user should be able to create new file from that mime type (`true` or `false`) +- `allow_creation` is whether a user should be able to create new file from that mime type (`true` or `false`) ### Listing available apps / mime types diff --git a/docs/extensions/storage/namespaces.md b/docs/extensions/storage/namespaces.md index 227835acd52..81fc82464b7 100644 --- a/docs/extensions/storage/namespaces.md +++ b/docs/extensions/storage/namespaces.md @@ -69,7 +69,7 @@ In ownCloud 10 you can not only create *public links* but also *private links*. |-|-| | https://demo.owncloud.com/apps/files/?dir=/Photos/Vacation&fileid=24 | The normal browser URL | | https://demo.owncloud.com/apps/files/?fileid=24 | the `dir` is actually not used to find the directory and will be filled when pasting this URL | -| https://demo.owncloud.com/f/24 | *private links* are the shortened version of this and workh in the same way | +| https://demo.owncloud.com/f/24 | *private links* are the shortened version of this and work in the same way | | https://demo.owncloud.com/s/piLdAAt1m3Bg0Fk | public link | {{< hint >}} diff --git a/docs/extensions/storage/spaces.md b/docs/extensions/storage/spaces.md index 567e8ddf2e1..d4e4f0d2575 100644 --- a/docs/extensions/storage/spaces.md +++ b/docs/extensions/storage/spaces.md @@ -193,7 +193,7 @@ Examples would be every user's personal storage *space*, project storage *spaces Finally, a logical `storage space id` is not tied to a specific [*spaces provider*]({{< ref "./spacesprovider.md" >}}). If the [*storage driver*]({{< ref "./storagedrivers.md" >}}) supports it, we can import existing files including their `file id`, which makes it possible to move storage *spaces* between [*spaces providers*]({{< ref "./spacesprovider.md" >}}) to implement storage classes, e.g. with or without archival, workflows, on SSDs or HDDs. ## Shares -*To be clarified: we are aware that [*storage spaces*]({{< ref "#storage-spaces" >}}) may be too 'heavywheight' for ad hoc sharing with groups. That being said, there is no technical reason why group shares should not be treated like storage [*spaces*]({{< ref "#storage-spaces" >}}) that users can provision themselves. They would share the quota with the users home or personal storage [*space*]({{< ref "#storage-spaces" >}}) and the share initiator would be the sole owner. Technically, the mechanism of treating a share like a new storage [*space*]({{< ref "#storage-spaces" >}}) would be the same. This obviously also extends to user shares and even file individual shares that would be wrapped in a virtual collection. It would also become possible to share collections of arbitrary files in a single storage space, e.g. the ten best pictures from a large album.* +*To be clarified: we are aware that [*storage spaces*]({{< ref "#storage-spaces" >}}) may be too 'heavyweight' for ad hoc sharing with groups. That being said, there is no technical reason why group shares should not be treated like storage [*spaces*]({{< ref "#storage-spaces" >}}) that users can provision themselves. They would share the quota with the users home or personal storage [*space*]({{< ref "#storage-spaces" >}}) and the share initiator would be the sole owner. Technically, the mechanism of treating a share like a new storage [*space*]({{< ref "#storage-spaces" >}}) would be the same. This obviously also extends to user shares and even file individual shares that would be wrapped in a virtual collection. It would also become possible to share collections of arbitrary files in a single storage space, e.g. the ten best pictures from a large album.* ## Notes diff --git a/docs/extensions/storage/terminology.md b/docs/extensions/storage/terminology.md index 4ff810e6736..638fb25c7c4 100644 --- a/docs/extensions/storage/terminology.md +++ b/docs/extensions/storage/terminology.md @@ -88,7 +88,7 @@ Examples would be every user's home storage space, project storage spaces or gro Finally, a logical `storage space id` is not tied to a specific [*storage provider*]({{< ref "#storage-providers" >}}). If the [*storage driver*]({{< ref "#storage-drivers" >}}) supports it, we can import existing files including their `file id`, which makes it possible to move [*storage spaces*]({{< ref "#storage-spaces" >}}) between [*storage providers*]({{< ref "#storage-providers" >}}) to implement storage classes, e.g. with or without archival, workflows, on SSDs or HDDs. ## Shares -*To be clarified: we are aware that [*storage spaces*]({{< ref "#storage-spaces" >}}) may be too 'heavyweight' for ad hoc sharEsing with groups. That being said, there is no technical reason why group shares should not be treated like [*storage spaces*]({{< ref "#storage-spaces" >}}) that users can provision themselves. They would share the quota with the users home [*storage space*]({{< ref "#storage-spaces" >}}) and the share initiator would be the sole owner. Technically, the mechanism of treating a share like a new [*storage space*]({{< ref "#storage-spaces" >}}) would be the same. This obviously also extends to user shares and even file individual shares that would be wrapped in a virtual collection. It would also become possible to share collections of arbitrary files in a single storage space, e.g. the ten best pictures from a large album.* +*To be clarified: we are aware that [*storage spaces*]({{< ref "#storage-spaces" >}}) may be too 'heavyweight' for ad hoc sharing with groups. That being said, there is no technical reason why group shares should not be treated like [*storage spaces*]({{< ref "#storage-spaces" >}}) that users can provision themselves. They would share the quota with the users home [*storage space*]({{< ref "#storage-spaces" >}}) and the share initiator would be the sole owner. Technically, the mechanism of treating a share like a new [*storage space*]({{< ref "#storage-spaces" >}}) would be the same. This obviously also extends to user shares and even file individual shares that would be wrapped in a virtual collection. It would also become possible to share collections of arbitrary files in a single storage space, e.g. the ten best pictures from a large album.* ## Storage Systems diff --git a/docs/ocis/adr/0004-support-hot-migration.md b/docs/ocis/adr/0004-support-hot-migration.md index 058528853c4..5cf4fcf3fe1 100644 --- a/docs/ocis/adr/0004-support-hot-migration.md +++ b/docs/ocis/adr/0004-support-hot-migration.md @@ -55,7 +55,7 @@ Chosen option: "\[option 1\]", because \[justification. e.g., only option, which ### Cold Migration -The migration happens while the service is offline. File metadata, blobs and share data is exported from ownCloud 10 and imported in oCIS. This can happen user by user, where every user export would contain the file blobs, their metadata, trash, versions, shares and all metadata that belongs to the users storage. To prevent group shares from breaking, users in the same groups must be migrated in batch. Depending on the actual group shares in an instance this may effectively require a complete migration in a single batch. +The migration happens while the service is offline. File metadata, blobs and share data is exported from ownCloud 10 and imported in oCIS. This can happen user by user, where every user export would contain the file blobs, their metadata, trash, versions, shares and all metadata that belongs to the user's storage. To prevent group shares from breaking, users in the same groups must be migrated in batch. Depending on the actual group shares in an instance this may effectively require a complete migration in a single batch. - Good, because oCIS can be tested in a staging system without writing to the production system. - Good, because file layout on disk can be changed to support new storage driver capabilities. @@ -69,7 +69,7 @@ The migration happens in subsequent stages while the service is online. - Good, because the admin can migrate users from old to new backend in a controlled way. - Good, because users and admins can learn to trust the new system. -- Good, because there can be preparations even long before the migrations happens in parallel on the oC10 codebase, ie. addition of metadata that is needed while the system operates. +- Good, because there can be preparations even long before the migrations happens in parallel on the oC10 codebase, i.e. addition of metadata that is needed while the system operates. - Good, because the downtime of the system can be fairly small. - Bad, because it is more complex and might drag on for a long time. diff --git a/docs/ocis/adr/0007-api-for-spaces.md b/docs/ocis/adr/0007-api-for-spaces.md index e86dd0a1fb8..feed42fb2d6 100644 --- a/docs/ocis/adr/0007-api-for-spaces.md +++ b/docs/ocis/adr/0007-api-for-spaces.md @@ -31,7 +31,7 @@ This API would even allow to provide (WebDAV-) endpoints depending on the kind a - No longer the need to make assumptions about WebDAV- and other routes in clients. - More meta data available about spaces for a better user experience. - Part of the bigger spaces plan. -- Important to consider in client migration scenarios, ie. in CERN. +- Important to consider in client migration scenarios, i.e. in CERN. ## Considered Options diff --git a/docs/ocis/adr/0015-events.md b/docs/ocis/adr/0015-events.md index 5358f47db38..af56da7f0fb 100644 --- a/docs/ocis/adr/0015-events.md +++ b/docs/ocis/adr/0015-events.md @@ -25,7 +25,7 @@ A simple example is the notification feature for oCIS: Users should receive an e * Events are supposed to decouple services and raise flexibility, also considering extensions that are not directly controlled by the ownCloud project. * Events should bring flexibility in the implementation of sending and receiving services. -* Events should not obsolete other mechanisms to communicate, ie. grpc calls. +* Events should not obsolete other mechanisms to communicate, i.e. grpc calls. * Sending an event has to be as little resource consuming for the sender as possible. * Events are never user visible. diff --git a/docs/ocis/development/getting-started.md b/docs/ocis/development/getting-started.md index a01001b6cdc..8616c524c82 100644 --- a/docs/ocis/development/getting-started.md +++ b/docs/ocis/development/getting-started.md @@ -35,7 +35,7 @@ The `docs` folder contains the source for the [oCIS documentation]({{< ref "../" The `deployments` folder contains documented deployment configurations and templates. On a single node, running a single ocis runtime is a resource efficient way to deploy ocis. For multiple nodes docker compose or helm charts for kubernetes examples can be found here. -The `scripts` folder contains scripts to perform various build, install, analysis, etc operations. +The `scripts` folder contains scripts to perform various build, install, analysis, etc. operations. ## Starting points