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.

Sign up for GitHub

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

readme: update doc links #741

Merged
merged 1 commit into from
Dec 2, 2024
+6 −12
Merged

readme: update doc links #741

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 6 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,32 +45,26 @@ EOF

## Documentation

### [Tutorials](./docs/tutorial)
### [Tutorials](https://piraeus.io/docs/stable/tutorial/)

Tutorials help you get started with Piraeus Operator.

### [How-To Guides](./docs/how-to)
### [How-To Guides](https://piraeus.io/docs/stable/how-to/)

How-To Guides show you how to configure a specific aspect or achieve a specific task with Piraeus Operator.

### [API Reference](./docs/reference)
### [API Reference](https://piraeus.io/docs/stable/reference/)

The API Reference for the Piraeus Operator. Contains documentation of the LINSTOR related resources that the user can
modify or observe.

### [Understanding Piraeus Datastore](./docs/explanation)
### [Understanding Piraeus Datastore](https://piraeus.io/docs/stable/explanation/)

These documents explain how Piraeus Datastore works, and why it works the way it does.

## Missing features
### [Upgrades](https://piraeus.io/docs/stable/upgrade/)

These are features that are currently present in Operator v1, and not yet available in this version of Operator v2:

* Backup of LINSTOR database before upgrades

## Upgrading

Please see the dedicated [UPGRADE document](./UPGRADE.md)
Details on the upgrade procedure for Piraeus Datastore.

## Contributing

Expand Down
Loading