Skip to content

Commit

Permalink
Merge pull request #1952 from owncloud/22042021_accounts-settings-gen…
Browse files Browse the repository at this point in the history
…erate-docs

[docs-only] Add release guides for accounts & settings, fix issue link in settings/package.json
  • Loading branch information
Pascal Wengerter authored Apr 28, 2021
2 parents 8ec196d + 46db2e8 commit a33c81c
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 2 deletions.
25 changes: 25 additions & 0 deletions docs/extensions/accounts/releasing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: "Releasing"
weight: 70
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/accounts
geekdocFilePath: releasing.md
---

{{< toc >}}

## Requirements

You need a working installation of [the Go programming language](https://golang.org/) installed to build the assets for a working release.

## Releasing

After adding changes to the accounts package within oCIS and testing them locally, you want to update the compiled assets to the oCIS binary.

To achieve this, you have to run a Go command and add the results to your PR. The preferred way to do this is to run `make generate` in the root
of the repository and then commit the resulting changes to your branch/PR.

### Package Hierarchy

- [ocis](https://github.com/owncloud/ocis)
- [ocis-accounts](https://github.com/owncloud/ocis/tree/master/accounts)
25 changes: 25 additions & 0 deletions docs/extensions/settings/releasing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: "Releasing"
weight: 70
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/settings
geekdocFilePath: releasing.md
---

{{< toc >}}

## Requirements

You need a working installation of [the Go programming language](https://golang.org/) installed to build the assets for a working release.

## Releasing

After adding changes to the settings package within oCIS and testing them locally, you want to update the compiled assets to the oCIS binary.

To achieve this, you have to run a Go command and add the results to your PR. The preferred way to do this is to run `make generate` in the root
of the repository and then commit the resulting changes to your branch/PR.

### Package Hierarchy

- [ocis](https://github.com/owncloud/ocis)
- [ocis-settings](https://github.com/owncloud/ocis/tree/master/settings)
2 changes: 1 addition & 1 deletion docs/extensions/web/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ To update this package within all the deliveries, we need to update the package

### Package Hierarchy

- [ocis](https://githug.com/owncloud/ocis)
- [ocis](https://github.com/owncloud/ocis)
- [ocis-web](https://github.com/owncloud/ocis/tree/master/web)
- [ocis-pkg](https://github.com/owncloud/ocis/tree/master/ocis-pkg)
- [ownCloud Web](https://github.com/owncloud/web)
Expand Down
2 changes: 1 addition & 1 deletion settings/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"author": "ownCloud GmbH <[email protected]>",
"repository": "https://github.com/owncloud/ocis-settings.git",
"bugs": {
"url": "https://github.com/owncloud/ocis/settings/issues",
"url": "https://github.com/owncloud/ocis/issues",
"email": "[email protected]"
},
"scripts": {
Expand Down

0 comments on commit a33c81c

Please sign in to comment.