Skip to content
This repository was archived by the owner on Jul 9, 2025. It is now read-only.

Conversation

@benbrown
Copy link
Contributor

@benbrown benbrown commented Mar 29, 2021

Description

  • Refactor bot settings page to fit the tabbed flow outlined in design spec (https://www.figma.com/file/tvENftrexoAYJngzsJxUbv/EmFig?node-id=2807%3A294)
    • UI implemented in this PR is initial tab flow, full execution of above spec will happen in a separate PR
  • Introduce a button to display the README file from a project. All new generated projects will include a readme file to display.
  • Introduce a button to display a readme file (if included) for any installed component
  • When installing a component, display the readme automatically post-install

Task Item

fixes #5779

Screenshots

Here is a movie of this in action:
https://www.loom.com/share/90e4ca972cc0448d9006fb580ba6fe3f

Screen shot of end tabbed bot settings page
image

Read in and display a readme.md for installed components
Pop up the readme after installing a component
@coveralls
Copy link

coveralls commented Mar 29, 2021

Coverage Status

Coverage increased (+0.3%) to 51.626% when pulling 2f13e3c on benbrown/readmes into 3b1cf77 on main.

beyackle
beyackle previously approved these changes Apr 5, 2021
Copy link
Contributor

@beyackle beyackle left a comment

Choose a reason for hiding this comment

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

One nitpicky thing you can change or not, otherwise this looks good.

const [readmeContent, setReadmeContent] = useState<string>('');
const [versionOptions, setVersionOptions] = useState<IContextualMenuProps | undefined>(undefined);
const [isUpdate, setIsUpdate] = useState<boolean>(false);
const [readmeHidden, setReadmeHidden] = useState<boolean>(true);
Copy link
Contributor

Choose a reason for hiding this comment

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

This may be my personal opinion here, but I find confusing when the variable value and the thing being hidden/shown matches. (not sure how to word this) So I would suggest something like const [showReadme] = useState(false) instead.

| createLuisResource | Optional | `true` | The LUIS prediction resource to create. Region is default to `westus` and cannot be changed. |
| createLuisAuthoringResource | Optional | true | The LUIS authoring resource to create. Region is default to `westus` and cannot be changed. |
| createQnAResource | Optional | `true` | The QnA resource to create. |
| createCosmosDB | Optional | `true` | The CosmosDB resource to create. |
Copy link
Contributor

Choose a reason for hiding this comment

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

#6637 updates this to createComsosDb.

@beyackle beyackle merged commit 984dae6 into main Apr 5, 2021
@beyackle beyackle deleted the benbrown/readmes branch April 5, 2021 23:14
@cwhitten cwhitten mentioned this pull request May 20, 2021
lei9444 pushed a commit to lei9444/BotFramework-Composer-1 that referenced this pull request Jun 15, 2021
* move provisionig readme into scripts folder so that main package readme is at root

* Read in and display a readme.md file for the project
Read in and display a readme.md for installed components
Pop up the readme after installing a component

* remove errant constant

* adding bot project tab view

* Updating botProjectInfo

* Adding support for deep linking into settings page

* Main merge clean up

* Fixing skills settings dependency

* Adding bottons for luis and qna provision in settings page

* Updating setting after qna and luis provisioning

* Naming changes for readme modal

* removing unused isBack option

* address feedback

* Adding formatMesage

* Removing unused ref

* Temp remove template tag and text

* Removing unused variables and deps

* removing unsed imports

* Adding testIds to tabs in settings page and updating broken integration test

* Fixing Luis deploy test to work with tab experience

* Fixing import in test

* Fixing header unit test

* use iconUrl field instead of icon. Fix for microsoft/botframework-components#802

* read in icon and include it as a data url

* Simplyfing array inclusion check

Co-authored-by: Patrick Volum <[email protected]>
Co-authored-by: pavolum <[email protected]>
Co-authored-by: Ben Yackley <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Post package/template install should display readme

8 participants