Skip to content

Commit

Permalink
Fix documentation (#372)
Browse files Browse the repository at this point in the history
* fix #351

* fix documentation requirements, remove unused links in docs

* add badges, remove old contacts from README.md
  • Loading branch information
k0ka authored Dec 12, 2023
1 parent 184990e commit e1c63af
Show file tree
Hide file tree
Showing 10 changed files with 24 additions and 24 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/integration_block_storage.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Run Block Storage Integration Tests
name: Block Storage Integration Tests

on:
workflow_dispatch:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/integration_compute.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Run Compute Integration Tests
name: Compute Integration Tests
on:
workflow_dispatch:
pull_request:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/integration_identity.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Run Identity Integration Tests
name: Identity Integration Tests
on:
workflow_dispatch:
pull_request:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/integration_images.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Run Images Integration Tests
name: Images Integration Tests
on:
workflow_dispatch:
pull_request:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/integration_networking.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Run Networking Integration Tests
name: Networking Integration Tests
on:
workflow_dispatch:
pull_request:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/integration_object_storage.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Run Object Storage Integration Tests
name: Object Storage Integration Tests
on:
workflow_dispatch:
pull_request:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/unit_tests.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Run Unit Tests
name: Unit Tests
on:
workflow_dispatch:
pull_request:
Expand Down
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
# PHP OpenStack SDK

[![Build Status](https://travis-ci.org/php-opencloud/openstack.svg?branch=master)](https://travis-ci.org/php-opencloud/openstack)
[![Coverage Status](https://coveralls.io/repos/github/php-opencloud/openstack/badge.svg?branch=master)](https://coveralls.io/github/php-opencloud/openstack?branch=master)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/php-opencloud/openstack/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/php-opencloud/openstack/?branch=master)

![Unit tests](https://github.com/php-opencloud/openstack/actions/workflows/unit_tests.yml/badge.svg)
[![Documentation Status](https://readthedocs.org/projects/php-openstack-sdk/badge/?version=latest)](https://php-openstack-sdk.readthedocs.io/en/latest/?badge=latest)

[![Block Storage Integration Tests](https://github.com/php-opencloud/openstack/actions/workflows/integration_block_storage.yml/badge.svg)](https://github.com/php-opencloud/openstack/actions/workflows/integration_block_storage.yml)
[![Compute Integration Tests](https://github.com/php-opencloud/openstack/actions/workflows/integration_compute.yml/badge.svg)](https://github.com/php-opencloud/openstack/actions/workflows/integration_compute.yml)
[![Identity Integration Tests](https://github.com/php-opencloud/openstack/actions/workflows/integration_identity.yml/badge.svg)](https://github.com/php-opencloud/openstack/actions/workflows/integration_identity.yml)
[![Images Integration Tests](https://github.com/php-opencloud/openstack/actions/workflows/integration_images.yml/badge.svg)](https://github.com/php-opencloud/openstack/actions/workflows/integration_images.yml)
[![Networking Integration Tests](https://github.com/php-opencloud/openstack/actions/workflows/integration_networking.yml/badge.svg)](https://github.com/php-opencloud/openstack/actions/workflows/integration_networking.yml)
[![Object Storage Integration Tests](https://github.com/php-opencloud/openstack/actions/workflows/integration_object_storage.yml/badge.svg)](https://github.com/php-opencloud/openstack/actions/workflows/integration_object_storage.yml)

`php-opencloud/openstack` is an SDK which allows PHP developers to easily connect to OpenStack APIs in a simple and
idiomatic way. This binding is specifically designed for OpenStack APIs, but other provider SDKs are available. Multiple
Expand Down Expand Up @@ -34,14 +41,13 @@ out by open an issue in github.

## Join the community

- Meet us on Slack: https://phpopencloud.slack.com ([Get your invitation](https://launchpass.com/phpopencloud))
- Report an issue: https://github.com/php-opencloud/openstack/issues

## Version Guidance

| Version | Status | PHP Version | Support until |
| --------- | --------------------------- | ---------------- | ----------------------- |
| `^3.2` | Latest | `>=7.2.5, >=8.0` | Current |
| `^3.2` | Latest | `>=7.2.5, >=8.0` | Current |
| `^3.1` | Latest | `>=7.2.5` | Current |
| `^3.0` | Bug fixed only | `>=7.0` | Oct 2020 |
| `^2.0` | End of life | `>=7.0,<7.2` | March 2018 |
Expand All @@ -57,7 +63,7 @@ This change was introduced in [#184](https://github.com/php-opencloud/openstack/

## Requirements

* PHP 7.0
* PHP >= 7.2.5
* `ext-curl`

## How to install
Expand All @@ -71,6 +77,5 @@ composer require php-opencloud/openstack
Engaging the community and lowering barriers for contributors is something we care a lot about. For this reason, we've
taken the time to write a [contributing guide](CONTRIBUTING.md) for folks interested in getting involved in our project.
If you're not sure how you can get involved, feel free to
[submit an issue](https://github.com/php-opencloud/openstack/issues/new) or
[contact us](https://developer.rackspace.com/support/). You don't need to be a PHP expert - all members of the
[submit an issue](https://github.com/php-opencloud/openstack/issues/new). You don't need to be a PHP expert - all members of the
community are welcome!
11 changes: 2 additions & 9 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Welcome to the OpenStack SDK for PHP!
Requirements
------------

* PHP 7
* PHP >= 7, < 9
* cURL extension

Installation
Expand Down Expand Up @@ -41,13 +41,7 @@ Supported services
Help and support
----------------

If you have specific problems or bugs with this SDK, please file an issue on our official `Github repo`_. We also
have a `mailing list`_, so feel free to join to keep up to date with all the latest changes and announcements to the
library.

For general feedback and support requests, send an email to [email protected].

You can also find assistance via IRC on #rackspace at freenode.net.
If you have specific problems or bugs with this SDK, please file an issue on our official `Github repo`_.

Contributing
------------
Expand All @@ -57,5 +51,4 @@ If you'd like to contribute to the project, or require help running the unit/int

.. _Composer installation instructions: `https://getcomposer.org/doc/00-intro.md`
.. _Github repo: `https://github.com/php-opencloud/openstack`
.. _mailing list: `https://groups.google.com/forum/#!forum/php-opencloud`
.. _contributing guidelines: `https://github.com/php-opencloud/openstack/blob/master/CONTRIBUTING.md`
2 changes: 2 additions & 0 deletions samples/Compute/v2/images/delete_image.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,5 @@
$compute = $openstack->computeV2(['region' => '{region}']);

$image = $compute->getImage(['id' => '{imageId}']);

$image->delete();

0 comments on commit e1c63af

Please sign in to comment.