Skip to content

#2641 Reorganize samples#2762

Merged
corinagum merged 68 commits intomicrosoft:masterfrom
corinagum:2641
Jan 3, 2020
Merged

#2641 Reorganize samples#2762
corinagum merged 68 commits intomicrosoft:masterfrom
corinagum:2641

Conversation

@corinagum
Copy link
Copy Markdown
Contributor

@corinagum corinagum commented Dec 18, 2019

Resolves #2641

Changelog Entry

Samples NOT tested:

The rest of the samples have been tested locally and work fine. Manual testing of samples after merge will be completed asap by me (this includes manual testing of hyperlinks to the samples)

@tdurnford and @compulim, sorry in advance that there are so many file changes. I got @stevengum to do an initial pass and he left some comments on questions we discussed in person.

Description

This is a rework of the samples directory. Overall structure has been discussed internally. Here are the new groupings:
00.migration
01.getting-started
02.branding-styling-and-customization
03.speech
04.api (intentionally left lowercase to match naming convention of other samples, e.g. ui instead of UI)
05.custom-components
06.recomposing-ui
07.advanced-web-chat-apps

Specific Changes

See below for screencaps of the new directory

image
image


  • Testing Added

Comment thread scripts/deploy_pages
@coveralls
Copy link
Copy Markdown

coveralls commented Dec 18, 2019

Coverage Status

Coverage remained the same at 65.915% when pulling 79bcd64 on corinagum:2641 into 54f67de on microsoft:master.

@corinagum corinagum changed the title #2641 Rename samples [DRAFT] #2641 Rename samples Dec 18, 2019

return mapped;
}, [array, mapper, nextMapperCalls]);
}, [array, mapper, nextMapperCalls, prevMapperCalls]);
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Discussed with @corinagum, this is a linting fix.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

via npm run eslint


- Fork this repository
- Navigate to `/Your-Local-WebChat/samples/01.c.getting-started-migration` in command line
- Navigate to `/Your-Local-WebChat/samples/00.migration/a.v3-to-v4` in command line
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

There are plans to add additional migration samples, hence the current sample structure for 00.migration/.

(Only one v3-to-v4 sample exists).

@corinagum corinagum changed the title [DRAFT] #2641 Rename samples #2641 Rename samples Dec 31, 2019
Comment thread package.json
"babel-jest": "^24.9.0",
"core-js": "^3.5.0",
"coveralls": "^3.0.9",
"eslint-plugin-react": "^7.17.0",
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I am not sure what I did, but I needed to reinstall this package while working on this PR

Comment thread README.md
| [`23.a.hybrid-react-npm`](https://github.com/microsoft/BotFramework-WebChat/tree/master/samples/23.a.hybrid-react-npm) | Demonstrates how to use different versions of React on a hosting app via NPM packages | [Hybrid React Demo](https://microsoft.github.io/BotFramework-WebChat/23.a.hybrid-react-npm) |
|                Sample Name                     | Description | Link |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Migration** | | |
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I know it's not ideal, but I intentionally did not add another column for directory groupings because it would severely limit the real estate available for listing the descriptions and sample names. If you have a better suggestion, please feel free.
We can also iterate on this table after this major sample is merged in.

@@ -0,0 +1,50 @@
pool:
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The .yml files were marked by git as deleted (and the new one added), as opposed to renamed. I'm assuming this is because there was a significant enough change to the file to consider it a new file.

@corinagum corinagum changed the title #2641 Rename samples #2641 Reorganize samples Dec 31, 2019
Copy link
Copy Markdown
Member

@stevengum stevengum left a comment

Choose a reason for hiding this comment

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

LGTM

Comment thread CHANGELOG.md Outdated
Comment thread samples/06.recomposing-UI/a.minimizable-web-chat/README.md
Comment thread samples/06.recomposing-UI/b.speech-ui/README.md Outdated
Copy link
Copy Markdown
Contributor

@tdurnford tdurnford left a comment

Choose a reason for hiding this comment

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

Green light

@corinagum corinagum merged commit 7946bde into microsoft:master Jan 3, 2020
@compulim compulim mentioned this pull request Mar 5, 2020
40 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Reorganize the samples list

4 participants