You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When a new service gets programmed, we do not have a checklist that needs to be processed that the service created is complete. Such a list should be published on owncloud.dev. Without claim of completeness or correct sort order, this is:
Provide a readme.md for that service
Use CamelCase for section headers.
If a new CLI command(s) is introduced, that command must be described in the readme.
Add the service to the makefile in the ocis repo root
Make the service startable for binary and individual startup
For single binary add service to ocis/pkg/runtime
For individual startup add service to ocis/pkg/commands
Add the service to .drone.star to enable ci
Make the service appear in owncloud.dev by creating a docs/services/{service} folder and adding at least
an _index.md that describes the service using a specific header content that you can derive eg from the _index.md file of the idm service. Remember to adapt accordingly (incl service name!)
For the content, use the text from the readme.me if you do not want to deviate, though you can write something different.
(Note that I have atm no clue how this works when embedding images)
a configuration.md that pulls in the autogenerated config. Derive from an existing one and adapt accordingly.
Inform doc team in an early stage to review the readme AND the environment variables created.
(the description must reflect the behaviour AND usually has a positive code quality impact)
Create proper description strings for envvars - see other services for examples, especially when it comes to multiple values
(base description, set of available values, description of each value)
When suggestable commits are created for text changes and you agree, collect them to a batch and commit them. Do not forget to rebase locally to avoid overwriting the changes made.
If new envvars are introduced which serve the same purpose but in multiple services, an additional envvar must be added at the beginning of the list starting with OCIS_ (global envvar).
When a new service gets programmed, we do not have a checklist that needs to be processed that the service created is complete. Such a list should be published on
owncloud.dev
. Without claim of completeness or correct sort order, this is:Use CamelCase for section headers.
ocis/pkg/runtime
ocis/pkg/commands
.drone.star
to enable ciowncloud.dev
by creating adocs/services/{service}
folder and adding at least_index.md
that describes the service using a specific header content that you can derive eg from the _index.md file of the idm service. Remember to adapt accordingly (incl service name!)(Note that I have atm no clue how this works when embedding images)
configuration.md
that pulls in the autogenerated config. Derive from an existing one and adapt accordingly.(the description must reflect the behaviour AND usually has a positive code quality impact)
(base description, set of available values, description of each value)
OCIS_
(global envvar).(see issue: Ensure all services have a debug port #5712)
FullDefaultConfig()
inpkg/config/defaults/defaultconfig.go
of your service. It is needed to create the documentation@ micbar @wkloucek @butonic @kobergj
The text was updated successfully, but these errors were encountered: