Documentation

Documentation for Shturval platform users includes descriptions of:

  • Shturval platform features;
  • working in the platform graphical interface;
  • step-by-step instructions for working in the platform and troubleshooting;
  • release changes.

Documentation types:

  • public;
  • private;
  • release.

Public and release documentation are versioned according to minor release versions. Private documentation is not versioned.

Public

Public documentation is available as a static website on the Internet at https://docs.shturval.tech. When you open the site, you see documentation for the version that matches the latest platform release. You can switch to documentation for previous releases. To do this, click Version x.x in the upper-right corner and select the version you need. Public documentation may be updated daily. Documentation for unsupported releases is removed from public access.

The public documentation includes these sections: • About the platform: general information about architecture and a glossary; • How-to guides: practical instructions; • Platform: system requirements, installation, firewalls, infrastructure, and access rights — everything that architecturally applies to the platform as a whole; • Clusters — all resources located in platform clusters, plus information about creating clusters on a deployed platform; • Namespaces — all resources within namespace scope; • Security — security features in the platform; • API reference — how to enable Swagger and API usage examples; • Services — working with services and repositories in the platform; • Releases — release notes;

The search bar works across all documentation pages.

Release

Release documentation is delivered with the platform. From platform GUI pages, you can navigate to release documentation that matches the platform version. Release documentation helps you find relevant information faster by linking directly to the page you need. It is updated together with minor and patch platform releases.

Private

Private documentation contains instructions and technical details tailored to customer tasks. It is developed and maintained according to customer needs. It is distributed through the Service Desk knowledge base and may be updated daily.

← User interface settings
Shturval versions →