Skip to content

Improve CLI and rewrite documentation

Latest

Choose a tag to compare

@github-actions github-actions released this 10 Nov 22:43
ca9c922

Contents (#739)

IMPORTANT: There are 4 breaking changes.

Enhancements

  • 💥 BREAKING CHANGE: Run local example service (Fibonacci calculator) if example is used as the service namespace in Child.ask
  • 💥 BREAKING CHANGE: Raise error if example is used as the service namespace in service configurations
  • Add Fibonacci sequence example function

Fixes

  • Update log message advising use of octue twined question command

Refactoring

  • 💥 BREAKING CHANGE: Remove --logger-uri option from CLI
  • 💥 BREAKING CHANGE: Un-nest CLI commands for asking questions
  • Factor out template setting as a class

Chores

  • Remove check-yaml pre-commit check

Documentation

  • Overhaul docs layout
  • Add getting started guides for using services, creating services, and managing infrastructure for services
  • Move most old docs into core concepts section
  • Consolidate old twined repo docs
  • Add troubleshooting infrastructure page
  • Add glossary
  • Use new URL for docs
  • Update CLI help text
  • Simplify installation instructions
  • Enable code snippet copy buttons
  • Adjust wording and style on licence and version history pages
  • Add support page
  • Improve authentication instructions

Upgrade instructions

💥 Run local example service (Fibonacci calculator) if `example` is used as the service namespace in service configurations

Stop using example as a service namespace unless you want to trigger the local example service.

💥 Raise error if example is used as the service namespace in service configurations

Stop using "example" as a service namespace in the service configuration class or octue.yaml file.

💥 Un-nest CLI commands for asking questions

Use:

  • octue twined question ask instead of octue twined question ask remote
  • octue twined question ask-local instead of octue twined question ask local
💥 Remove `--logger-uri` option from CLI

Stop providing the --logger-uri option to the CLI