Skip to content

Eliminate specific version numbers from examples and docs to extent possible #160

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.

Sign up for GitHub

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

Jump to bottom
Closed
lance opened this issue May 14, 2020 · 3 comments · Fixed by #211
Closed

Eliminate specific version numbers from examples and docs to extent possible #160

lance opened this issue May 14, 2020 · 3 comments · Fixed by #211
Assignees
@lholmquist
Labels
good first issue Good for newcomers module/docs Module documentation changes

Comments

@lance
Copy link
Member

lance commented May 14, 2020

In general, the version specific comments throughout these docs will have a short shelf life.

https://github.com/cloudevents/sdk-javascript/pull/141/files#r424509323

This is generally true. We should, as much as possible, find a way to eliminate these from the docs and examples except where it can't be avoided - e.g. providing a version number to an emitter to ensure that an event is transported via a specific spec version.
@lance lance added good first issue Good for newcomers module/docs Module documentation changes labels May 14, 2020
@lance lance mentioned this issue May 14, 2020
Merged
@lholmquist
Copy link
Contributor

@lance i can take a look at this if it is still open?

@lance
Copy link
Member Author

lance commented Jun 3, 2020

It's all yours @lholmquist :)

lholmquist added a commit to lholmquist/sdk-javascript that referenced this issue Jun 8, 2020
@lholmquist
docs: Update references of specific versions to use Latest Supported.
e420eec 
fixes cloudevents#160

Signed-off-by: Lucas Holmquist <lholmqui@redhat.com>
@lholmquist lholmquist mentioned this issue Jun 8, 2020
Merged
@lance lance closed this as completed in #211 Jun 8, 2020
lance pushed a commit that referenced this issue Jun 8, 2020
@lholmquist
docs: Update references of specific versions to use Latest Supported. (…
ed1d328 
…#211)

* docs: Update references of specific versions to use Latest Supported.

fixes #160

Signed-off-by: Lucas Holmquist <lholmqui@redhat.com>
@grant
Copy link
Member

grant commented Jun 8, 2020 •
edited
Loading

Won't this version of the README/code be invalid when the spec reaches 2.0 and a user clones the old version?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lholmquist lholmquist

Labels
good first issue Good for newcomers module/docs Module documentation changes
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: Update references of specific versions to use Latest Supported. lholmquist/sdk-javascript
3 participants
@lance @grant @lholmquist