Skip to content

Commit e1c63af

Browse files
authored
Fix documentation (#372)
* fix #351 * fix documentation requirements, remove unused links in docs * add badges, remove old contacts from README.md
1 parent 184990e commit e1c63af

File tree

10 files changed

+24
-24
lines changed

10 files changed

+24
-24
lines changed

.github/workflows/integration_block_storage.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Run Block Storage Integration Tests
1+
name: Block Storage Integration Tests
22

33
on:
44
workflow_dispatch:

.github/workflows/integration_compute.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Run Compute Integration Tests
1+
name: Compute Integration Tests
22
on:
33
workflow_dispatch:
44
pull_request:

.github/workflows/integration_identity.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Run Identity Integration Tests
1+
name: Identity Integration Tests
22
on:
33
workflow_dispatch:
44
pull_request:

.github/workflows/integration_images.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Run Images Integration Tests
1+
name: Images Integration Tests
22
on:
33
workflow_dispatch:
44
pull_request:

.github/workflows/integration_networking.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Run Networking Integration Tests
1+
name: Networking Integration Tests
22
on:
33
workflow_dispatch:
44
pull_request:

.github/workflows/integration_object_storage.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Run Object Storage Integration Tests
1+
name: Object Storage Integration Tests
22
on:
33
workflow_dispatch:
44
pull_request:

.github/workflows/unit_tests.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Run Unit Tests
1+
name: Unit Tests
22
on:
33
workflow_dispatch:
44
pull_request:

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
# PHP OpenStack SDK
22

3-
[![Build Status](https://travis-ci.org/php-opencloud/openstack.svg?branch=master)](https://travis-ci.org/php-opencloud/openstack)
4-
[![Coverage Status](https://coveralls.io/repos/github/php-opencloud/openstack/badge.svg?branch=master)](https://coveralls.io/github/php-opencloud/openstack?branch=master)
5-
[![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)
3+
4+
![Unit tests](https://github.com/php-opencloud/openstack/actions/workflows/unit_tests.yml/badge.svg)
5+
[![Documentation Status](https://readthedocs.org/projects/php-openstack-sdk/badge/?version=latest)](https://php-openstack-sdk.readthedocs.io/en/latest/?badge=latest)
6+
7+
[![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)
8+
[![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)
9+
[![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)
10+
[![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)
11+
[![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)
12+
[![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)
613

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

3542
## Join the community
3643

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

4046
## Version Guidance
4147

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

5864
## Requirements
5965

60-
* PHP 7.0
66+
* PHP >= 7.2.5
6167
* `ext-curl`
6268

6369
## How to install
@@ -71,6 +77,5 @@ composer require php-opencloud/openstack
7177
Engaging the community and lowering barriers for contributors is something we care a lot about. For this reason, we've
7278
taken the time to write a [contributing guide](CONTRIBUTING.md) for folks interested in getting involved in our project.
7379
If you're not sure how you can get involved, feel free to
74-
[submit an issue](https://github.com/php-opencloud/openstack/issues/new) or
75-
[contact us](https://developer.rackspace.com/support/). You don't need to be a PHP expert - all members of the
80+
[submit an issue](https://github.com/php-opencloud/openstack/issues/new). You don't need to be a PHP expert - all members of the
7681
community are welcome!

doc/index.rst

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Welcome to the OpenStack SDK for PHP!
44
Requirements
55
------------
66

7-
* PHP 7
7+
* PHP >= 7, < 9
88
* cURL extension
99

1010
Installation
@@ -41,13 +41,7 @@ Supported services
4141
Help and support
4242
----------------
4343

44-
If you have specific problems or bugs with this SDK, please file an issue on our official `Github repo`_. We also
45-
have a `mailing list`_, so feel free to join to keep up to date with all the latest changes and announcements to the
46-
library.
47-
48-
For general feedback and support requests, send an email to [email protected].
49-
50-
You can also find assistance via IRC on #rackspace at freenode.net.
44+
If you have specific problems or bugs with this SDK, please file an issue on our official `Github repo`_.
5145

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

5852
.. _Composer installation instructions: `https://getcomposer.org/doc/00-intro.md`
5953
.. _Github repo: `https://github.com/php-opencloud/openstack`
60-
.. _mailing list: `https://groups.google.com/forum/#!forum/php-opencloud`
6154
.. _contributing guidelines: `https://github.com/php-opencloud/openstack/blob/master/CONTRIBUTING.md`

samples/Compute/v2/images/delete_image.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,5 @@
1515
$compute = $openstack->computeV2(['region' => '{region}']);
1616

1717
$image = $compute->getImage(['id' => '{imageId}']);
18+
19+
$image->delete();

0 commit comments

Comments
 (0)