Rewrite documentation

[cortadocodes]

Contents (#739)

IMPORTANT: There are 3 breaking changes.

New features

• Add octue twined question ask example command
• Add ExampleChild and use in CLI

Enhancements

• Update docs URL in CLI help text
• Add dummy output values to example command
• Merge example CLI subcommand into remote subcommand
• Give ExampleChild same signature as Child
• 💥 BREAKING CHANGE: Raise error if "example" is used as a service namespace
• Replace ExampleChild with Child with "example" namespace

Fixes

• Clean up after template class
• Return correct values from ExampleChild.ask

Dependencies

• Move strincase from dev to production dependencies

Refactoring

• Factor out template setting as a class
• 💥 BREAKING CHANGE: Remove --logger-uri option from CLI
• Remove unnecessary context manager from ExampleChild
• Use analysis ID in example child and simplify template variable
• Simplify ExampleChild.__init__
• 💥 BREAKING CHANGE: Un-nest CLI commands for asking questions

Chores

• Remove check-yaml pre-commit check

Other

• Use new URL for docs
• Update CLI help text
• Simplify installation instructions
• Add getting started guide to index page of docs
• Add command for real data service to getting started
• Fix nested bulleted list
• Adjust wording
• Explain question/answer terminology
• Add shell redirection tip and add JSON link
• Simplify installation instructions
• Enable tabbed docs
• Add CLI tab to getting started guide
• Add empty python tab to getting started guide
• Add python code to getting started guide
• Enable code snippet copy buttons
• Adjust wording and fix typo
• Add "next steps" to end of getting started guide
• Adjust wording and style on licence and version history pages
• Use ExampleChild in getting started guide
• Add infrastructure page to docs
• Add support page
• Add links to getting started guide
• Add link to github issues
• Move admonition and clarify it
• Remove old documentation from navigation
• Remove old documentation
• Add glossary
• Add outline "creating services" doc
• Add overview page and move getting started guide
• Add more info to overview
• Split docs into three main sections
• Add placeholders for authentication docs
• Add intro lines to getting started guides
• Add links to getting started guides to index page
• Add content to using services authentication page
• Number headings in index
• Add getting started guide for creating services
• Add remaining content to creating services getting started guide
• Remove redundant authentication page
• Remove incorrect backticks from shell command
• Simplify constraint on creating services quickstart guide
• Improve creating services quickstart
• Add data containers docs
• Add more core concepts

---

Upgrade instructions

💥 Remove `--logger-uri` option from CLI

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

💥 Raise error if "example" is used as a service namespace

Stop using "example" as a service namespace

💥 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

[codecov-commenter]

Codecov Report

❌ Patch coverage is 77.96610% with 13 lines in your changes missing coverage. Please review.
✅ Project coverage is 93.75%. Comparing base (d1c12ff) to head (6bb9d4b).
⚠️ Report is 70 commits behind head on main.

Files with missing lines	Patch %	Lines
octue/twined/resources/example.py	18.18%	9 Missing ⚠️
octue/cli.py	72.72%	3 Missing ⚠️
octue/twined/resources/child.py	66.66%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #739      +/-   ##
==========================================
- Coverage   93.98%   93.75%   -0.24%     
==========================================
  Files          97       99       +2     
  Lines        3858     3904      +46     
==========================================
+ Hits         3626     3660      +34     
- Misses        232      244      +12     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.