From 3957ab96e49574cc42438bda1687fa5945ce089a Mon Sep 17 00:00:00 2001 From: Pascal Wengerter Date: Tue, 27 Apr 2021 17:18:27 +0100 Subject: [PATCH] Update accounts & settings release docs according to feedback --- docs/extensions/accounts/releasing.md | 9 +++++++-- docs/extensions/settings/releasing.md | 9 +++++++-- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/docs/extensions/accounts/releasing.md b/docs/extensions/accounts/releasing.md index dce405219..afc419081 100644 --- a/docs/extensions/accounts/releasing.md +++ b/docs/extensions/accounts/releasing.md @@ -8,11 +8,16 @@ 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. +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. +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. See below for a way to _only_ build the accounts extension assets. ### Package Hierarchy diff --git a/docs/extensions/settings/releasing.md b/docs/extensions/settings/releasing.md index 811724a6a..6de38e3a7 100644 --- a/docs/extensions/settings/releasing.md +++ b/docs/extensions/settings/releasing.md @@ -8,11 +8,16 @@ 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. +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 run a Go command and add the results to your PR. +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. See below for a way to _only_ build the settings extension assets. ### Package Hierarchy