Skip to content

Changed to match current library distribution status #213

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

Merged
mattheworiordan merged 4 commits into from
Dec 13, 2016
Merged

Changed to match current library distribution status #213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8647170
Changed to match current library distribution status
psolstice Nov 29, 2016
4ec1156
Changed Java/Android compilation method to gradle
Nov 30, 2016
cedbc18
Fixed formatting
psolstice Dec 1, 2016
75f5901
Added references to Bintray to get the lastest possible version of Ja…
psolstice Dec 13, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions content/realtime/usage.textile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,23 @@ blang[ruby].
```

blang[java].
The Realtime library for Java and Android is "hosted on Github":https://github.com/ably/ably-java and is downloadable as a JAR from "https://github.com/ably/ably-java/releases":https://github.com/ably/ably-java/releases or via "JCentre":https://bintray.com/ably-io/ably.
The Realtime library for Java and Android is "hosted on Github":https://github.com/ably/ably-java and can be used by adding one line to @build.gradle@ dependencies section.

Ensure the JAR is included in your classpath as follows:
For Java applications:

```[java]
compile 'io.ably:ably-java:0.8.7'
```

For Android apps:

```[java]
compile 'io.ably:ably-android:0.8.7'
```

In the above example a specific version of the library is referenced, however we recommend you check which is the latest stable version and always use that. Follow links to get the latest stable release for "Java":https://bintray.com/ably-io/ably/ably-java and "Android":https://bintray.com/ably-io/ably/ably-android.

Ensure the library is included in your classpath as follows:
Copy link
Copy Markdown
Member

@mattheworiordan mattheworiordan Nov 30, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there not a way to not fix into a specific version?

Copy link
Copy Markdown
Member

@paddybyers paddybyers Nov 30, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

compile "io.ably:ably-android:0.8.+" ? @psolstice ?

Copy link
Copy Markdown
Contributor Author

@psolstice psolstice Dec 1, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's possible to do it this way but some IDEs (e.g. Android Studio) will give a warning and strongly discourage you from doing so.

Copy link
Copy Markdown
Member

@paddybyers paddybyers Dec 1, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@psolstice @mattheworiordan I agree it is discouraged so although it's a pain I think on balance it is probably better to update the tutorials and docs when there are new releases; hopefully the releases will settle down so it's not happening too often.

Copy link
Copy Markdown
Member

@mattheworiordan mattheworiordan Dec 1, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@paddybyers that sounds like a nightmare, especially as that couples releases of Java with the docs repo. Personally I'd prefer that we at least recommend that users simply check for the latest version with a link to the tags / releases for the Java repo so that they can see the versions. WDYT?

Copy link
Copy Markdown
Member

@paddybyers paddybyers Dec 1, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's fine. I don't think the docs and tutorials always have to point to the latest, but equally we'll need to ensure they're reasonably up to date

Copy link
Copy Markdown
Member

@mattheworiordan mattheworiordan Dec 13, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe the action here is to add some comments about replacing with the latest version? Also, I assume now unfortunately #215 (comment) is incorrect. If so, that's a huge pain, see https://github.com/ably/tutorials/pulls to get an idea why, that's 6 PRs to fix all the commit SHAs that are then referenced from #215 (comment)


```[java]
import io.ably.lib.types.*;
Expand Down
18 changes: 16 additions & 2 deletions content/rest/usage.textile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,9 +106,23 @@ blang[php].
```

blang[java].
The REST library for Java and Android is "hosted on Github":https://github.com/ably/ably-java and is downloadable as a JAR from "https://github.com/ably/ably-java/releases":https://github.com/ably/ably-java/releases or via "JCentre":https://bintray.com/ably-io/ably.
The REST library for Java and Android is "hosted on Github":https://github.com/ably/ably-java and can be used by adding one line to @build.gradle@ dependencies section.

Ensure the JAR is included in your classpath as follows:
For Java applications:

```[java]
compile 'io.ably:ably-java:0.8.7'
```

For Android apps:

```[java]
compile 'io.ably:ably-android:0.8.7'
```

In the above example a specific version of the library is referenced, however we recommend you check which is the latest stable version and always use that. Follow links to get the latest stable release for "Java":https://bintray.com/ably-io/ably/ably-java and "Android":https://bintray.com/ably-io/ably/ably-android.

Ensure the library is included in your classpath as follows:
Copy link
Copy Markdown
Member

@mattheworiordan mattheworiordan Dec 13, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did we not agree we'd mention that the version number should be updated with perhaps links to the latest version numbers?


```[java]
import io.ably.lib.types.*;
Expand Down
19 changes: 17 additions & 2 deletions content/root/quick-start-guide.textile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,24 @@ blang[php].
bc[php]. require_once __DIR__ . '/../vendor/autoload.php';

blang[java].
The Ably library for Java and Android is downloadable as a JAR from "https://github.com/ably/ably-java/releases":https://github.com/ably/ably-java/releases or via "JCentre":https://bintray.com/ably-io/ably.
The Ably library for Java and Android is "hosted on Github":https://github.com/ably/ably-java and can be used by adding one line to @build.gradle@ dependencies section.

Ensure the JAR is included in your classpath as follows:
For Java applications:

```[java]
compile 'io.ably:ably-java:0.8.7'
```

For Android apps:

```[java]
compile 'io.ably:ably-android:0.8.7'
```

In the above example a specific version of the library is referenced, however we recommend you check which is the latest stable version and always use that. Follow links to get the latest stable release for "Java":https://bintray.com/ably-io/ably/ably-java and "Android":https://bintray.com/ably-io/ably/ably-android.


Ensure the library is included in your classpath as follows:

```[java]
import io.ably.lib.types.*;
Expand Down
16 changes: 2 additions & 14 deletions content/tutorials/history.textile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,10 @@ blang[java].

repositories {
jcenter()
maven { url "https://raw.github.com/paddybyers/Java-WebSocket/mvn-repo/" }
}
Copy link
Copy Markdown
Member

@mattheworiordan mattheworiordan Nov 30, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we still need jcenter() then?

Copy link
Copy Markdown
Member

@paddybyers paddybyers Nov 30, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes

Copy link
Copy Markdown
Contributor Author

@psolstice psolstice Dec 1, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If user is using IDE this line is generated automatically

Copy link
Copy Markdown
Member

@mattheworiordan mattheworiordan Dec 1, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, fine, just checking


dependencies {
compile 'io.ably:ably-java:0.8.4'
compile 'io.ably:ably-java:0.8.7'
}
```

Expand Down Expand Up @@ -86,18 +85,7 @@ blang[android].
...
dependencies {
...
compile 'io.ably:ably-java:0.8.4'
}
```

Also add following repo for a sub-dependency in your project-level @gradle.build@ file.

```[groovy]
allprojects {
repositories {
...
maven { url "https://raw.github.com/paddybyers/Java-WebSocket/mvn-repo/" }
}
compile 'io.ably:ably-android:0.8.7'
}
```

Expand Down
16 changes: 2 additions & 14 deletions content/tutorials/publish-subscribe.textile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,10 @@ blang[java].

repositories {
jcenter()
maven { url "https://raw.github.com/paddybyers/Java-WebSocket/mvn-repo/" }
}

dependencies {
compile 'io.ably:ably-java:0.8.4'
compile 'io.ably:ably-java:0.8.7'
}
```

Expand Down Expand Up @@ -70,18 +69,7 @@ blang[android].
...
dependencies {
...
compile 'io.ably:ably-java:0.8.4'
}
```

Also add following repo for a sub-dependency in your project-level @gradle.build@ file.

```[groovy]
allprojects {
repositories {
...
maven { url "https://raw.github.com/paddybyers/Java-WebSocket/mvn-repo/" }
}
compile 'io.ably:ably-android:0.8.7'
}
```

Expand Down