Skip to content

Commit 0eeba65

Browse files
GregHolmesGregHolmes
authored
[EDU-2044] - Remove SDK set up pages and redirect to getting started landing pages
2 parents 1cb83c7 + cbe0398 commit 0eeba65

File tree

9 files changed

+126
-432
lines changed

9 files changed

+126
-432
lines changed

‎src/components/Layout/mdx/tiles.tsx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ const Tile = ({ title, description, image, link = '/docs' }: TileProps) => {
3232

3333
export const Tiles = ({ children }: { children: TileProps[] }) => {
3434
return (
35-
<div className="grid grid-cols-1 sm:grid-cols-2 gap-4 pb-40">
35+
<div className="grid grid-cols-1 sm:grid-cols-2 gap-4">
3636
{children
3737
.filter((item) => item.title && item.description)
3838
.map((item: TileProps) => (

‎src/components/SDKsPage/Card/index.tsx‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,18 @@ const Card = ({ githubRepoURL, setupLink, title, image, text }: CardProps) => {
2626
<p className="ui-text-p3 py-4">{text}</p>
2727
<div className="flex flex-col justify-center gap-2">
2828
<Link to={setupLink} rel="noreferrer" className={cn(btn_sdks, 'ui-button-primary gap-2')}>
29-
Setup <Icon name="icon-gui-arrow-long-right-micro" size="1rem" />
29+
Get started <Icon name="icon-gui-arrow-long-right-micro" size="1rem" />
3030
</Link>
31-
<a
32-
href={githubRepoURL}
33-
target="_blank"
34-
rel="noreferrer"
35-
className={cn(btn_sdks, 'ui-button-secondary gap-2 align-middle')}
36-
>
37-
<span className="relative top-px">GitHub</span> <Icon name="icon-social-github" size="1.125rem" />
38-
</a>
31+
{githubRepoURL && (
32+
<a
33+
href={githubRepoURL}
34+
target="_blank"
35+
rel="noreferrer"
36+
className={cn(btn_sdks, 'ui-button-secondary gap-2 align-middle')}
37+
>
38+
<span className="relative top-px">GitHub</span> <Icon name="icon-social-github" size="1.125rem" />
39+
</a>
40+
)}
3941
</div>
4042
</section>
4143
);

‎src/components/SDKsPage/data.ts‎

Lines changed: 32 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import js from './images/js.svg';
22
import java from './images/java.svg';
33
import python from './images/python.svg';
44
import react from './images/react.svg';
5+
import reactnative from './images/reactnative.svg';
56
import csharp from './images/csharp.svg';
67
import go from './images/go.svg';
78
import nodejs from './images/nodejs.svg';
@@ -33,155 +34,139 @@ export const data = {
3334
title: 'JavaScript',
3435
text: 'Ably SDK for JavaScript.',
3536
image: { src: js, isWide: false },
36-
githubRepoURL: 'https://github.com/ably/ably-js',
37-
setupLink: 'getting-started/setup?lang=javascript',
37+
setupLink: 'getting-started/javascript',
3838
},
3939
{
4040
title: 'Java',
4141
text: 'Ably SDK for Java.',
4242
image: { src: java, isWide: false },
43-
githubRepoURL: 'https://github.com/ably/ably-java',
44-
setupLink: 'getting-started/setup?lang=java',
43+
setupLink: 'getting-started/java',
4544
},
4645
{
4746
title: 'Python',
4847
text: 'Ably SDK for Python.',
4948
image: { src: python, isWide: false },
50-
githubRepoURL: 'https://github.com/ably/ably-python',
51-
setupLink: 'getting-started/setup?lang=python',
49+
setupLink: 'getting-started/python',
5250
},
5351
{
5452
title: 'React',
5553
text: 'Ably React Hooks package.',
5654
image: { src: react, isWide: false },
57-
githubRepoURL: 'https://github.com/ably/ably-js',
58-
setupLink: 'getting-started/react-hooks',
55+
setupLink: 'getting-started/react',
56+
},
57+
{
58+
title: 'React Native',
59+
text: 'Ably React Native SDK.',
60+
image: { src: reactnative, isWide: false },
61+
setupLink: 'getting-started/react-native',
5962
},
6063
{
6164
title: 'C#.NET',
6265
text: 'Ably SDK for C#.NET.',
6366
image: { src: csharp, isWide: false },
64-
githubRepoURL: 'https://github.com/ably/ably-dotnet',
65-
setupLink: 'getting-started/setup?lang=csharp',
67+
setupLink: 'getting-started/dotnet',
6668
},
6769
{
6870
title: 'Go',
6971
text: 'Ably SDK for Go.',
7072
image: { src: go, isWide: false },
71-
githubRepoURL: 'https://github.com/ably/ably-go',
72-
setupLink: 'getting-started/setup?lang=go',
73+
setupLink: 'getting-started/go',
7374
},
7475
{
7576
title: 'Node.js',
7677
text: 'Ably SDK for Node.js.',
7778
image: { src: nodejs, isWide: false },
78-
githubRepoURL: 'https://github.com/ably/ably-js',
79-
setupLink: 'getting-started/setup?lang=nodejs',
79+
setupLink: 'getting-started/node',
8080
},
8181
{
8282
title: 'Ruby',
8383
text: 'Ably SDK for Ruby.',
8484
image: { src: ruby, isWide: false },
85-
githubRepoURL: 'https://github.com/ably/ably-ruby',
86-
setupLink: 'getting-started/setup?lang=ruby',
85+
setupLink: 'getting-started/ruby',
8786
},
8887
{
8988
title: 'Swift',
9089
text: 'Ably SDK for Swift.',
9190
image: { src: swift, isWide: false },
92-
githubRepoURL: 'https://github.com/ably/ably-cocoa',
93-
setupLink: 'getting-started/setup?lang=swift',
91+
setupLink: 'getting-started/swift',
9492
},
9593
{
9694
title: 'Objective-C',
9795
text: 'Ably SDK for Objective-C.',
9896
image: { src: objectivec, isWide: false },
99-
githubRepoURL: 'https://github.com/ably/ably-cocoa',
100-
setupLink: 'getting-started/setup?lang=objc',
97+
setupLink: 'getting-started/objective-c',
10198
},
10299
{
103100
title: 'Flutter',
104101
text: 'Ably SDK for Flutter.',
105102
image: { src: flutter, isWide: false },
106-
githubRepoURL: 'https://github.com/ably/ably-flutter',
107-
setupLink: 'getting-started/setup?lang=flutter',
103+
setupLink: 'getting-started/flutter',
108104
},
109105
{
110106
title: 'PHP',
111107
text: 'Ably SDK for PHP.',
112108
image: { src: php, isWide: false },
113-
githubRepoURL: 'https://github.com/ably/ably-php',
114-
setupLink: 'getting-started/setup?lang=php',
109+
setupLink: 'getting-started/php',
115110
},
116111
{
117112
title: 'PHP Laravel',
118113
text: 'Ably SDK for PHP Laravel.',
119114
image: { src: laravel, isWide: false },
120-
githubRepoURL: 'https://github.com/ably/ably-php#laravel-realtime-broadcasting',
121-
setupLink: 'https://github.com/ably/ably-php#laravel-realtime-broadcasting',
115+
setupLink: 'getting-started/laravel',
122116
},
123117
{
124118
title: 'Android',
125119
text: 'Ably SDK for Android.',
126120
image: { src: android, isWide: false },
127-
githubRepoURL: 'https://github.com/ably/ably-java',
128-
setupLink: 'getting-started/setup?lang=java',
121+
setupLink: 'getting-started/kotlin',
129122
},
130123
{
131124
title: 'Kotlin',
132125
text: 'Ably SDK for Kotlin.',
133126
image: { src: kotlin, isWide: false },
134-
githubRepoURL: 'https://github.com/ably/ably-java',
135-
setupLink: 'getting-started/setup?lang=java',
127+
setupLink: 'getting-started/kotlin',
136128
},
137129
{
138130
title: 'Unity',
139131
text: 'Ably SDK for Unity.',
140132
image: { src: unity, isWide: false },
141-
githubRepoURL: 'https://github.com/ably/ably-dotnet',
142133
setupLink: 'https://github.com/ably/ably-dotnet/blob/main/unity/README.md',
143134
},
144135
{
145136
title: 'Xamarin',
146137
text: 'Ably SDK for Xamarin.',
147138
image: { src: xamarin, isWide: false },
148-
githubRepoURL: 'https://github.com/ably/ably-dotnet',
149-
setupLink: 'getting-started/setup?lang=csharp',
139+
setupLink: 'getting-started/dotnet',
150140
},
151141
{
152142
title: 'NativeScript',
153143
text: 'Ably SDK for NativeScript.',
154144
image: { src: nativescript, isWide: false },
155-
githubRepoURL: 'https://github.com/ably/ably-js-nativescript',
156145
setupLink: 'https://github.com/ably/ably-js-nativescript#how-to-use-this-library',
157146
},
158147
{
159148
title: 'React Native',
160149
text: 'Ably SDK for React Native.',
161150
image: { src: react, isWide: false },
162-
githubRepoURL: 'https://github.com/ably/ably-js',
163-
setupLink: 'getting-started/react-hooks',
151+
setupLink: 'getting-started/react-native',
164152
},
165153
{
166154
title: 'Cordova',
167155
text: 'Ably SDK for Cordova.',
168156
image: { src: cordova, isWide: false },
169-
githubRepoURL: 'https://github.com/ably/ably-js',
170-
setupLink: 'getting-started/setup?lang=javascript',
157+
setupLink: 'getting-started/javascript',
171158
},
172159
{
173160
title: 'Clojure',
174161
text: 'Ably SDK for Clojure.',
175162
image: { src: clojure, isWide: false },
176-
githubRepoURL: 'https://github.com/ably/ably-java',
177-
setupLink: 'getting-started/setup?lang=java',
163+
setupLink: 'getting-started/java',
178164
},
179165
{
180166
title: 'Scala',
181167
text: 'Ably SDK for Scala.',
182168
image: { src: scala, isWide: false },
183-
githubRepoURL: 'https://github.com/ably/ably-java',
184-
setupLink: 'getting-started/setup?lang=java',
169+
setupLink: 'getting-started/java',
185170
},
186171
],
187172
},
@@ -192,14 +177,12 @@ export const data = {
192177
title: 'JavaScript',
193178
text: 'Ably Spaces SDK for JavaScript.',
194179
image: { src: js, isWide: false },
195-
githubRepoURL: 'https://github.com/ably/spaces',
196180
setupLink: 'spaces/setup',
197181
},
198182
{
199183
title: 'React',
200184
text: 'Ably Spaces React Hooks package.',
201185
image: { src: react, isWide: false },
202-
githubRepoURL: 'https://github.com/ably/spaces',
203186
setupLink: 'spaces/react',
204187
},
205188
],
@@ -211,29 +194,25 @@ export const data = {
211194
title: 'JavaScript',
212195
text: 'Ably Chat SDK for JavaScript.',
213196
image: { src: js, isWide: false },
214-
githubRepoURL: 'https://github.com/ably/ably-chat-js',
215-
setupLink: 'chat/setup?lang=javascript',
197+
setupLink: 'chat/getting-started/javascript',
216198
},
217199
{
218200
title: 'React',
219201
text: 'Ably Chat React Hooks package.',
220202
image: { src: react, isWide: false },
221-
githubRepoURL: 'https://github.com/ably/ably-chat-js',
222-
setupLink: 'chat/setup?lang=react',
203+
setupLink: 'chat/getting-started/react',
223204
},
224205
{
225206
title: 'Swift',
226207
text: 'Ably Chat SDK for Swift.',
227208
image: { src: swift, isWide: false },
228-
githubRepoURL: 'https://github.com/ably/ably-chat-swift',
229-
setupLink: 'chat/setup?lang=swift',
209+
setupLink: 'chat/getting-started/swift',
230210
},
231211
{
232212
title: 'Kotlin',
233213
text: 'Ably Chat SDK for Kotlin.',
234214
image: { src: kotlin, isWide: false },
235-
githubRepoURL: 'https://github.com/ably/ably-chat-kotlin',
236-
setupLink: 'chat/setup?lang=kotlin',
215+
setupLink: 'chat/getting-started/kotlin',
237216
},
238217
],
239218
},
@@ -244,21 +223,18 @@ export const data = {
244223
title: 'JavaScript',
245224
text: 'LiveObjects plugin for JavaScript.',
246225
image: { src: js, isWide: false },
247-
githubRepoURL: 'https://github.com/ably/ably-js',
248226
setupLink: 'liveobjects/quickstart/javascript',
249227
},
250228
{
251229
title: 'Swift',
252230
text: 'LiveObjects plugin for Swift.',
253231
image: { src: swift, isWide: false },
254-
githubRepoURL: 'https://github.com/ably/ably-liveobjects-swift-plugin',
255232
setupLink: 'liveobjects/quickstart/swift',
256233
},
257234
{
258235
title: 'Java',
259236
text: 'LiveObjects plugin for Java.',
260237
image: { src: java, isWide: false },
261-
githubRepoURL: 'https://github.com/ably/ably-java/tree/main/liveobjects',
262238
setupLink: 'liveobjects/quickstart/java',
263239
},
264240
],
@@ -270,8 +246,7 @@ export const data = {
270246
title: 'JavaScript',
271247
text: 'Ably Models SDK for JavaScript.',
272248
image: { src: js, isWide: false },
273-
githubRepoURL: 'https://github.com/ably-labs/models',
274-
setupLink: 'livesync/postgres/models',
249+
setupLink: 'livesync/postgres/quickstart',
275250
},
276251
],
277252
},

‎src/components/SDKsPage/images/reactnative.svg‎

Lines changed: 4 additions & 0 deletions
Loading

‎src/data/nav/chat.ts‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,11 @@ export default {
1919
{
2020
name: 'Getting started',
2121
pages: [
22+
{
23+
name: 'Overview',
24+
link: '/docs/chat/getting-started',
25+
index: true,
26+
},
2227
{
2328
name: 'JavaScript',
2429
link: '/docs/chat/getting-started/javascript',

‎src/data/nav/pubsub.ts‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,6 @@ export default {
8686
},
8787
],
8888
},
89-
{
90-
name: 'SDK setup',
91-
link: '/docs/getting-started/setup',
92-
},
9389
{
9490
name: 'React Hooks',
9591
link: '/docs/getting-started/react-hooks',

0 commit comments

Comments
 (0)