Migrate _most_ of the Client Library Development Guide to ably/specification - #1608
Conversation
…ks to new homes on sdk.ably.com. This commit does not move: - features.textile, which will be done under a dedicated commit - documentation-formatting-guide.textile, as it is likely to continue living in this repository, perhaps under a different folder
… guide with links to new homes on sdk.ably.com. Done in VS Code with a regex search and replace: - Search: `^(\*+) @\((\w+)\)@.+` - Replace: `$1 @($2)@ Moved to "here on *sdk.ably.com*":https://sdk.ably.com/builds/ably/specification/main/features/#$2`
… library development guide with links to new homes on sdk.ably.com.
…spec has moved elsewhere.
Validation of the integrity of the features spec will now take place in its new home. see: ably/specification#1 (comment)
While this file was in the `content/client-lib-development-guide` folder in its original `ably/docs` repository home, its contents falls outside of scope for this `ably/specification` repository. see: ably/docs#1608
|
Thanks for the review input so far. ❤️ ... Just a quick reminder that we'll not merge this pull request until after ably/specification#4 has merged. |
m-hulbert
left a comment
m-hulbert
left a comment
There was a problem hiding this comment.
Approving as this all looks good and I have no objections.
Two comments I'd like your opinion on though @QuintinWillison:
- I think the previous versions and diffs should be preserved, and in my opinion this makes sense to be stored with the latest spec (even if just in raw textile).
- Any objections if we get redirects set up with the web team in the future to remove these pages from docs entirely? Do we need to preserve the deep links of the features spec for anything?
|
Thanks, @m-hulbert. I have thoughts on both:
I disagree. The change history has to, logically, be discernible using
I would love for that to happen and I had presumed that this would be the next logical step, after this pull request has landed. My intention here was to get the 'soft redirects' in place. What I would want to see from future redirects, of course, is that they also carry over the HTML element id anchors too. Some of these documents are quite long and that was one of my goals, to keep that rich, deep linking carrying forwards. |
* Tutorials should be accessed from ably.com/tutorials * Client library development guides have moved to sdk.ably.com in #1608
While this file was in the `content/client-lib-development-guide` folder in its original `ably/docs` repository home, its contents falls outside of scope for this `ably/specification` repository. see: ably/docs#1608
While this file was in the `content/client-lib-development-guide` folder in its original `ably/docs` repository home, its contents falls outside of scope for this `ably/specification` repository. see: ably/docs#1608
6 participants
Apologies for the size of this pull request, but it's logical and necessary to perform this content migration atomically.
All 'moved to' (new home) URLs I've added begin with
https://sdk.ably.com/builds/ably/specification/main/however those links will give you a403 Access Denieduntil ably/specification#4 has landed to themainbranch of theably/specificationrepository, which is the source code base that renders the content to HTML and pushes out tosdk.ably.com.