[docs-only] Add release guides for accounts & settings, fix issue link in settings/package.json #1952
Conversation
|
Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would create a changelog item based on your changes. |
| #### Updating ocis-accounts | ||
|
|
||
| 1. Make sure you are inside the [ocis repository](https://github.com/owncloud/ocis) and on your feature branch | ||
| 2. Change into accounts' asset package folder via `cd accounts/pkg/assets` |
There was a problem hiding this comment.
running 'make generate' in the root of the oCIS repository generates these assets for all oCIS extension and you also can invoke it inside the folder of an extension to just run in for a single extension.
It is already described here, but it seems to be not accessible enough / in an place where people look for it: https://owncloud.dev/ocis/development/build/#build-the-ocis-binary
There was a problem hiding this comment.
Should we keep both texts since both are (technically) correct? I wrote those with the idea in mind that somebody only touches the accounts/settings extension and finds all the necessary information in one place :)
There was a problem hiding this comment.
I see it as a very good addition but would like to advice people only to use 'make generate' because it acts as abstraction an d also does more than just 'go generate'.
There was a problem hiding this comment.
Updated the PR with a suggestion!
There was a problem hiding this comment.
Okay @wkloucek I just ran make generate on master and ended up with five embed.go files that vary from the ones in version control 🥴 and now I'm confused!
There was a problem hiding this comment.
@wkloucek updated the guides and reduced them to the make generate cmd
|
My dream is to use the new embed package and replace this asset generation :) |
This cries for a ticket in the oCIS repo so it can be added to a sprint and implemented soon? 🕴🏽 |
pascalwengerter
requested review from
individual-it,
micbar and
phil-davis
as code owners
Co-authored-by: Alex Unger <[email protected]>
pascalwengerter
force-pushed
the
22042021_accounts-settings-generate-docs
branch
from
efd1741 to
95bf02f
Compare
If we document only 'make generate' this change is abstracted for users and they can continue using their known command, so this should not block this PR ;-) |
exactly, it's a "behind the curtains" kind of change |
Co-authored-by: Phil Davis <[email protected]>
Co-authored-by: Phil Davis <[email protected]>
delete-merged-branch
bot
deleted the
22042021_accounts-settings-generate-docs
branch
Merge: 8ec196d 46db2e8 Author: Pascal Wengerter <[email protected]> Date: Wed Apr 28 13:02:59 2021 +0100 Merge pull request #1952 from owncloud/22042021_accounts-settings-generate-docs [docs-only] Add release guides for accounts & settings, fix issue link in settings/package.json
Description
Within the
v1.5.0release of oCIS, I had to work on theaccountsandsettingsextensions and almost forgot adding their respectiveembed.gofiles to Git. After searching for a while and requesting help from @fschade I managed to do so, but documenting this in written form will help both outside contributors as well as team members in the future.Types of changes