Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing ToDo list available in owncloud.dev when creating a new service #5710

Closed
14 tasks
mmattel opened this issue Mar 2, 2023 · 1 comment · Fixed by #5916
Closed
14 tasks

Missing ToDo list available in owncloud.dev when creating a new service #5710

mmattel opened this issue Mar 2, 2023 · 1 comment · Fixed by #5916

Comments

@mmattel
Copy link
Contributor

mmattel commented Mar 2, 2023

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).
  • Ensure that a service has a debug port
    (see issue: Ensure all services have a debug port #5712)
  • If the new service introduces a new port for its use, the port must be added to port-ranges.md and to the readme.md / _index.md file.
  • Make sure to have a function FullDefaultConfig() in pkg/config/defaults/defaultconfig.go of your service. It is needed to create the documentation
  • ...

@ micbar @wkloucek @butonic @kobergj

@mmattel
Copy link
Contributor Author

mmattel commented Mar 15, 2023

@micbar pls add how to do translations if the service requires this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant