Adding Deprecation links #556
Conversation
jamiehannaford
force-pushed
the
deprecation-links
branch
from
5ff27a4
to
fc34c29
Compare
| ## 5. Other functionality | ||
|
|
||
| For a full list of functionality provided by Guzzle, please consult the [official documentation](http://docs.guzzlephp.org/en/latest/http-client/client.html). | ||
| https://doc.php-opencloud.com/en/latest/index.html |
There was a problem hiding this comment.
Any reason you decided not to have a separate document on Clients in the new documentation?
There was a problem hiding this comment.
I thought about it, but every service now in its introduction references how to set up the relevant client and service (for both OS and RS). It provides the sample and explains all the arguments in detail, so I didn't think a separate document (that wasn't tied to a specific service) would have much use. What do you think?
There was a problem hiding this comment.
I agree that a separate, standalone document on setting up OS/RS clients is not useful any more. There are, however, other parts of this document - specifically the parts about User Agents and Loggers - that are not included anywhere else in the new documentation. Do you think we ought to create a separate document (or documents) for them, if we are going to remove this document on Clients?
There was a problem hiding this comment.
yes, definitely - that was an oversight on my part. I think we should add add them as separate documents and link to them in the "usage tips" toctree in index.rst
There was a problem hiding this comment.
Sounds good. Do you want to include them in this PR (I would prefer this as the Clients document is being deleted in this PR) or in a separate PR?
There was a problem hiding this comment.
yup, I'll add now and rebase too
jamiehannaford
force-pushed
the
deprecation-links
branch
from
fc34c29
to
95ffc95
Compare
|
@ycombinator ok, I've added some more docs - does that cover everything? We need to set up the CNAME before this PR is merged |
|
@ycombinator The DNS migration is done 🤘 This is ready for review again |
Note: this PR depends on #555 being merged first. We also need to setup
docs.php-opencloud.comCNAME (or whatever the subdomain will be) first. I've just noticed that I've referenceddoc.*- so I'll need to do a search and replace and rebase