-
Notifications
You must be signed in to change notification settings - Fork 4
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.
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
Move the features specification to this repository #1
Comments
Do we also want to have a step for creating / documenting the workflow for running the static site locally, similar to what is described in https://github.com/ably/docs#quickstart? And if we do that, I wonder how we'd handle links from the features spec to other parts of the docs site, e.g.
|
Thanks, @lawrence-forooghian, that's a good point. We will hit that hurdle when working on this task and the answer will hopefully present itself - which could be as simple as some kind of once-only mutation of the textile file to convert these from relative to absolute links. |
This issue has a duplicate, created last year, so the comments in that issue should be considered when working on this issue. They both could be closed by the work done under this issue. |
Once this issue has been worked on then we will also need to update this: https://github.com/ably/engineering/blob/main/sdk/versioning.md#features-specification-and-protocol-versioning |
When assessing this features spec change PR, which I think clearly sits in the |
The change made to implement this issue must also include an equivalent to https://github.com/ably/docs/blob/main/scripts/find-duplicate-spec-items |
See also: #2 (comment) |
The initial content copy and Git commit history regeneration has now been done, with notes as to 'How' added as repository content here (it might be useful for future). This issue will not be closed, however, until the content has been replaced in |
Validation of the integrity of the features spec will now take place in its new home. see: ably/specification#1 (comment)
Before closing this issue, we should ensure that this pull request has been merged: ably/docs#1608 |
In the
features/
folder readme added in ably/ably-common#142 this task is mentioned in the section headed 'Future Direction for the Client Library Features Specification' (once that PR lands, that section should be visible here).The work required to complete this task is, as I see it...
1. Create copy in this repository
Copy current state of
features.textile
fromably/docs
and commit it to this repository, in thefeatures/
folder, with a logical file name for its new home - I would suggestsdk-specification.textile
.In the commit (via a PR) that adds this new file to this repository, include in the message a reference to the SHA it was copied over from in the docs repository. Likely
HEAD
of themain
(default) branch. This may come handy in the future. 😉2. Add GitHub workflow to render
It should be relatively trivial to use textile tools (probably Ruby-based, I guess, akin to what's used in the docs repository currently) to transform
sdk-specification.textile
to HTML so that it can be pushed tosdk.ably.com
using our standard structure and mechanism.3. Transfer issues
Issues that currently reside in the docs repository with the
client-lib-spec
label need to be transferred to this repository with a similar label, or perhaps something more appropriate (and less abbreviated 😉). FYI, @deanna-lad4. Redirect visitors to the docs site
Coordinating with the docs team, replace the contents of
features.textile
inably/docs
with something explaining that it has moved. This should include a pointer to the new source location as well as the new rendered location. FYI, tbedford Srushtika┆Issue is synchronized with this Jira Uncategorised by Unito
The text was updated successfully, but these errors were encountered: