Skip to content

Commit f1b5994

Browse files
xuesichaoxuesichao
authored
Revert change to replace markdown links with HTML <a> tag (#792)
1 parent ce1d272 commit f1b5994

26 files changed

+108
-109
lines changed

‎CHANGELOG.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2222
### Fixed
2323

2424
- Fix command line sample to install latest node dependencies in migration guides.
25-
- Fix the broken markdown URLs due to this [storybook issue](https://github.com/storybookjs/storybook/issues/9005) by replacing markdown links with HTML `<a>` tag.
2625
- Clarify `setIsVideoEnabled` usage in `LocalVideoProvider` and `useLocalVideo` docs.
2726

2827
## [3.0.0] - 2022-03-17

‎src/components/introduction.stories.mdx‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ For the majority of use cases, an Amazon Chime application consists of **a serve
2020

2121
The server application and client application could be hosted either locally or in the cloud (serverless).
2222

23-
- For hosting locally, see the <a target="_blank" href="https://github.com/aws-samples/amazon-chime-sdk/tree/main/apps/meeting/src">client application</a> and <a target="_blank" href="https://github.com/aws-samples/amazon-chime-sdk/blob/main/apps/meeting/server.js">server application</a>.
24-
- For hosting in the cloud, see the <a target="_blank" href="https://github.com/aws-samples/amazon-chime-sdk/tree/main/apps/meeting/serverless">serverless example</a>.
23+
- For hosting locally, see the [client application](https://github.com/aws-samples/amazon-chime-sdk/tree/main/apps/meeting/src) and [server application](https://github.com/aws-samples/amazon-chime-sdk/blob/main/apps/meeting/server.js).
24+
- For hosting in the cloud, see the [serverless example](https://github.com/aws-samples/amazon-chime-sdk/tree/main/apps/meeting/serverless).
2525

2626
## Getting Started
2727

@@ -61,14 +61,14 @@ To join a meeting, you need to do the following sub steps:
6161

6262
- Create and join the meeting
6363

64-
First, you need to fetch the meeting and attendee data from Chime's <a target="_blank" href="https://docs.aws.amazon.com/chime/latest/APIReference/API_CreateAttendee.html">CreateAttendee</a> and <a target="_blank" href="https://docs.aws.amazon.com/chime/latest/APIReference/API_CreateMeeting.html">CreateMeeting</a> APIs.
64+
First, you need to fetch the meeting and attendee data from Chime's [CreateAttendee](https://docs.aws.amazon.com/chime/latest/APIReference/API_CreateAttendee.html) and [CreateMeeting](https://docs.aws.amazon.com/chime/latest/APIReference/API_CreateMeeting.html) APIs.
6565

66-
- Check the <a target="_blank" href="https://github.com/aws/amazon-chime-sdk-js#getting-responses-from-your-server-application">Getting responses from your server application</a> for details.
67-
- Check the <a target="_blank" href="https://github.com/aws-samples/amazon-chime-sdk/blob/main/apps/meeting/src/containers/MeetingForm/index.tsx">MeetingForm component</a>, the <a target="_blank" href="https://github.com/aws-samples/amazon-chime-sdk/blob/main/apps/meeting/src/utils/api.ts">API calls</a>, and <a target="_blank" href="https://github.com/aws-samples/amazon-chime-sdk/blob/main/apps/meeting/server.js">server application</a> in our <a target="_blank" href="https://github.com/aws-samples/amazon-chime-sdk/tree/main/apps/meeting">React meeting demo</a> as examples.
66+
- Check the [Getting responses from your server application](https://github.com/aws/amazon-chime-sdk-js#getting-responses-from-your-server-application) for details.
67+
- Check the [MeetingForm component](https://github.com/aws-samples/amazon-chime-sdk/blob/main/apps/meeting/src/containers/MeetingForm/index.tsx), the [API calls](https://github.com/aws-samples/amazon-chime-sdk/blob/main/apps/meeting/src/utils/api.ts), and [server application](https://github.com/aws-samples/amazon-chime-sdk/blob/main/apps/meeting/server.js) in our [React meeting demo](https://github.com/aws-samples/amazon-chime-sdk/tree/main/apps/meeting) as examples.
6868

6969
Then, initialize `MeetingSessionConfiguration` with the meeting and attendee data from the last step. You can choose to modify the `MeetingSessionConfiguration` properties to customize the meeting to your preference.
7070

71-
Updating the `MeetingSessionConfiguration` props is an optional step. You can learn more about the available props here: <a target="_blank" href="https://aws.github.io/amazon-chime-sdk-js/classes/meetingsessionconfiguration.html">MeetingSessionConfiguration</a>
71+
Updating the `MeetingSessionConfiguration` props is an optional step. You can learn more about the available props here: [MeetingSessionConfiguration](https://aws.github.io/amazon-chime-sdk-js/classes/meetingsessionconfiguration.html)
7272

7373
Lastly, pass the `MeetingSessionConfiguration` to the `join` method to create a meeting session. You can now start the meeting session and join the meeting.
7474

@@ -117,7 +117,7 @@ const MyMeetingView = () => {
117117
};
118118
```
119119

120-
For more common use cases, please review our <a target="_blank" href="https://aws.github.io/amazon-chime-sdk-component-library-react/?path=/story/quick-starts--page">Quick Starts</a> guide.
120+
For more common use cases, please review our [Quick Starts](https://aws.github.io/amazon-chime-sdk-component-library-react/?path=/story/quick-starts--page) guide.
121121

122122
## FAQ
123123

‎src/components/migrationToV2.stories.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,6 @@ change it to something like this:
150150

151151
### Other Changes
152152

153-
The `ChatBubbleContainer` and `Textarea` components now includes the use of `React.forwardRef` and may have a new backwards-incompatible signature. <a target="_blank" href="https://reactjs.org/docs/forwarding-refs.html#note-for-component-library-maintainers">Link to source</a>.
153+
The `ChatBubbleContainer` and `Textarea` components now includes the use of `React.forwardRef` and may have a new backwards-incompatible signature. [Link to source](https://reactjs.org/docs/forwarding-refs.html#note-for-component-library-maintainers).
154154

155155
The `Roster` component has been changed from rendering as a `div` to a more semantic `aside` element.

‎src/components/migrationToV3.stories.mdx‎

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ npm install --save amazon-chime-sdk-component-library-react@3 amazon-chime-sdk-j
2121

2222
Amazon Chime SDK React Components Library v3 includes major improvements for component style customization, `MeetingProvider/MeetingManager` configuration, device management, WebRTC metrics and logger.
2323

24-
- **Component style customization**: Improve components for easier customization of style. Check out our <a target="_blank" href="https://aws.github.io/amazon-chime-sdk-component-library-react/?path=/story/styling-guide--page">styling guide</a> for more information.
24+
- **Component style customization**: Improve components for easier customization of style. Check out our [styling guide](https://aws.github.io/amazon-chime-sdk-component-library-react/?path=/story/styling-guide--page) for more information.
2525
- **`MeetingProvider/MeetingManager` configuration**: Improve `MeetingProvider`, `MeetingManager` and `MeetingManager.join()` API to allow configuring a meeting session right before joining a meeting instead of when `MeetingProvider` mounts.
2626
- **Device management**: Improve `types` for device selection components to better support basic and transformed devices. Remove `useSelectAudioInputDevice`, `useSelectVideoInputDevice`, and `useSelectAudioOutputDevice` hooks to standardize device selection through `MeetingManager` and throw error when selection fails.
2727
- **WebRTC metrics**: Publish the standardized WebRTC metrics for all supported browsers. Deprecate `useBandwidthMetrics` hook in favor of `useMediaStreamMetrics` hook.
@@ -254,7 +254,7 @@ const MyApp = () => {
254254

255255
### `MeetingManager` `join` method parameter change
256256

257-
In V3, `MeetingManager`'s `join` method takes `MeetingSessionConfiguraiton` and `options` as parameter.
257+
In V3, `MeetingManager`'s `join` method takes `MeetingSessionConfiguration` and `options` as parameter.
258258
`meetingInfo` and `attendeeInfo` parameters are removed from the interface and are rather passed to the constructor of `MeetingSessionConfiguration`.
259259

260260
Before in 2.x:
@@ -436,25 +436,25 @@ When you implement your own theme, you need to use `globalStyle` instead of `glo
436436

437437
In V3, some of device management APIs, hooks and types have been renamed for more accurate description. To migrate, use new names summarized in table below.
438438

439-
| Before in 2.x | After in 3.x |
440-
| ----------------------------------------------------------- | ---------------------------------------------------------- |
441-
| `DevicePermissionStatus` | `DeviceLabelTriggerStatus` |
442-
| `DevicePermissionStatus.UNSET` | `DevicePermissionStatus.UNTRIGGERED` |
443-
| `useDevicePermissionStatus` | `useDeviceLabelTriggerStatus` |
444-
| | |
445-
| `MeetingManager.devicePermissionStatus` | `MeetingManager.deviceLabelTriggerStatus` |
446-
| | |
447-
| `MeetingManager.selectAudioInputDevice()` | `MeetingManager.startAudioInputDevice()` |
448-
| `MeetingManager.selectAudioOutputDevice()` | `MeetingManager.startAudioOutputDevice()` |
449-
| `MeetingManager.selectVideoInputDevice()` | `MeetingManager.startVideoInputDevice()` |
450-
| | |
451-
| `MeetingManager.devicePermissionsObservers` | `MeetingManager.deviceLabelTriggerStatusObservers` |
452-
| `MeetingManager.subscribeToDevicePermissionStatus()` | `MeetingManager.subscribeToDeviceLabelTriggerStatus()` |
453-
| `MeetingManager.unsubscribeFromDevicePermissionStatus()` | `MeetingManager.unsubscribeFromDeviceLabelTriggerStatus()` |
454-
| | |
455-
| `MeetingManager.deviceLabelTriggerChangeObservers` | `MeetingManager.deviceLabelTriggerObservers` |
456-
| `MeetingManageer.subscribeToDeviceLabelTriggerChange()` | `MeetingManageer.subscribeToDeviceLabelTrigger()` |
457-
| `MeetingManageer.unsubscribeFromDeviceLabelTriggerChange()` | `MeetingManageer.unsubscribeFromDeviceLabelTrigger()` |
439+
| Before in 2.x | After in 3.x |
440+
| --------------------------------------------------------------------- | --------------------------------------------------------------------- |
441+
| <code>DevicePermissionStatus</code> | <code>DeviceLabelTriggerStatus</code> |
442+
| <code>DevicePermissionStatus.UNSET</code> | <code>DevicePermissionStatus.UNTRIGGERED</code> |
443+
| <code>useDevicePermissionStatus</code> | <code>useDeviceLabelTriggerStatus</code> |
444+
| | |
445+
| <code>MeetingManager.devicePermissionStatus</code> | <code>MeetingManager.deviceLabelTriggerStatus</code> |
446+
| | |
447+
| <code>MeetingManager.selectAudioInputDevice()</code> | <code>MeetingManager.startAudioInputDevice()</code> |
448+
| <code>MeetingManager.selectAudioOutputDevice()</code> | <code>MeetingManager.startAudioOutputDevice()</code> |
449+
| <code>MeetingManager.selectVideoInputDevice()</code> | <code>MeetingManager.startVideoInputDevice()</code> |
450+
| | |
451+
| <code>MeetingManager.devicePermissionsObserver</code> | <code>MeetingManager.deviceLabelTriggerStatusObservers</code> |
452+
| <code>MeetingManager.subscribeToDevicePermissionStatus()</code> | <code>MeetingManager.subscribeToDeviceLabelTriggerStatus()</code> |
453+
| <code>MeetingManager.unsubscribeFromDevicePermissionStatus()</code> | <code>MeetingManager.unsubscribeFromDeviceLabelTriggerStatus()</code> |
454+
| | |
455+
| <code>MeetingManager.deviceLabelTriggerChangeObservers</code> | <code>MeetingManager.deviceLabelTriggerObservers</code> |
456+
| <code>MeetingManager.subscribeToDeviceLabelTriggerChange()</code> | <code>MeetingManager.subscribeToDeviceLabelTrigger()</code> |
457+
| <code>MeetingManager.unsubscribeFromDeviceLabelTriggerChange()</code> | <code>MeetingManager.unsubscribeFromDeviceLabelTrigger()</code> |
458458

459459
#### New API for Handling Video Input Device Switching
460460

@@ -532,51 +532,51 @@ const MyChild = () => {
532532
};
533533
```
534534
535-
536535
### Update Type of Selected Device in MeetingManager
537536
538537
In V3, we have improved the `type` for selected device in `MeetingManager` and corresponding components and hooks.
539538
540539
#### MeetingManager Properties Change
541540
542541
```ts
543-
// Before in 2.x
544-
selectedAudioOutputDevice: string | null
545-
selectedAudioInputDevice: string | null
546-
selectedVideoInputDevice: string | null
542+
// Before in 2.x
543+
selectedAudioOutputDevice: string | null;
544+
selectedAudioInputDevice: string | null;
545+
selectedVideoInputDevice: string | null;
547546

548547
// After in 3.x
549-
selectedAudioOutputDevice: string | null
550-
selectedAudioInputDevice: AudioInputDevice | undefined
551-
selectedVideoInputDevice: VideoInputDevice | undefined
548+
selectedAudioOutputDevice: string | null;
549+
selectedAudioInputDevice: AudioInputDevice | undefined;
550+
selectedVideoInputDevice: VideoInputDevice | undefined;
552551
```
553552
554553
```ts
555554
type Device = string | MediaTrackConstraints | MediaStream;
556555
type AudioInputDevice = Device | AudioTransformDevice | null;
557556
type VideoInputDevice = Device | VideoTransformDevice;
558557
```
558+
559559
#### Hooks Return Values Change
560560
561561
Before in 2.x
562562
563563
```js
564-
// Selected audio output deivce. The type is `string | null`
564+
// Selected audio output device. The type is `string | null`
565565
const { selectedDevice } = useAudioOutputs();
566-
// Selected audio input deivce. The type is `string | null`
566+
// Selected audio input device. The type is `string | null`
567567
const { selectedDevice } = useAudioInputs();
568-
// Selected video input deivce. The type is `string | null`
568+
// Selected video input device. The type is `string | null`
569569
const { selectedDevice } = useVideoInputs();
570570
```
571571
572572
After in 3.x
573573
574574
```js
575-
// Selected audio output deivce. The type is `string | null`
575+
// Selected audio output device. The type is `string | null`
576576
const { selectedDevice } = useAudioOutputs();
577-
// Selected audio input deivce. The type is `AudioInputDevice | undefined`
577+
// Selected audio input device. The type is `AudioInputDevice | undefined`
578578
const { selectedDevice } = useAudioInputs();
579-
// Selected video input deivce. The type is `VideoInputDevice | undefined`
579+
// Selected video input device. The type is `VideoInputDevice | undefined`
580580
const { selectedDevice } = useVideoInputs();
581581
```
582582

0 commit comments

Comments
 (0)