Skip to content
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.

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

Jwilaby/debugging doc #1463

Merged
merged 7 commits into from Apr 25, 2019
Merged

Jwilaby/debugging doc #1463

merged 7 commits into from Apr 25, 2019

Conversation

justinwilaby
Copy link
Contributor

@justinwilaby justinwilaby commented Apr 25, 2019

Related to #1443 - This PR provides:

  1. A general purpose Markdown Renderer page
  2. A new help menu item for getting started with debugging your bot via channels
  3. A link on the Welcome page (when in sidecar debug mode) to the same help document

To test:
Checkout the branch and change this line to use https://raw.githubusercontent.com/Microsoft/BotFramework-Emulator/jwilaby/debugging-doc/content/CHANNELS.md

note The images in the current document do not render (non-standard MD). This document is a placeholder and will change once we engage with the documents team.

Screen Shot 2019-04-25 at 11 52 21 AM

image

@coveralls
Copy link

coveralls commented Apr 25, 2019

Coverage Status

Coverage increased (+0.09%) to 57.031% when pulling 6a3c82c on jwilaby/debugging-doc into cf9f0e8 on master.

@cwhitten
Copy link
Member

cwhitten commented Apr 25, 2019

It looks like the Bot Inspector heading got bumped to the right a bit. It was flush with the other headings.

@mewa1024 and I discussed adding the link in the area where the My Bots box lives in Emulator mode. Though right next to the (BETA) label it seems more discoverable.

@mewa1024
Copy link

mewa1024 commented Apr 25, 2019 via email

@tonyanziano
Copy link
Contributor

@mewa1024 From the first screenshot it appears to belong to its own tab:

image

@tonyanziano
Copy link
Contributor

tonyanziano commented Apr 25, 2019

@justinwilaby I just noticed, you probably want to go to this function, get iconClass() inside of tab.tsx and add the document id for your docs page as a case right above welcome-page so that the icon for that doc tab defaults to the BF icon instead of the chat bubble.

@justinwilaby
Copy link
Contributor Author

justinwilaby commented Apr 25, 2019

So we’re not displaying the sidecar doc as it’s own tab, similarly to VS Code’s Release Notes (Help > Release notes)? Get Outlook for iOShttps://aka.ms/o0ukef

________________________________ From: Chris Whitten notifications@github.com Sent: Thursday, April 25, 2019 12:07:38 PM To: Microsoft/BotFramework-Emulator Cc: Melanie Wang; Mention Subject: Re: [Microsoft/BotFramework-Emulator] Jwilaby/debugging doc (#1463) It looks like the Bot Inspector heading got bumped to the right a bit. It was flush with the other headings. @mewa1024https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fmewa1024&data=01%7C01%7Cmewa%40microsoft.com%7Cf9528e4907d24a18c14e08d6c9b1496d%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=07i2EAZYwG7JyDdKsg7C%2BLYIxtLNkykexZd2F3Mr8NY%3D&reserved=0 and I discussed adding the link in the area where the My Bots box lives in Emulator mode. Though right next to the (BETA) label it seems a more discoverable. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHubhttps://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FMicrosoft%2FBotFramework-Emulator%2Fpull%2F1463%23issuecomment-486800422&data=01%7C01%7Cmewa%40microsoft.com%7Cf9528e4907d24a18c14e08d6c9b1496d%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=FkyC8gi0u8DGIyYSSWLteEHtinZsJ0aYHqPyQxIicOs%3D&reserved=0, or mute the threadhttps://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAJL7AJWOFPGSAIHODEOFYUTPSH6PVANCNFSM4HIPYPBQ&data=01%7C01%7Cmewa%40microsoft.com%7Cf9528e4907d24a18c14e08d6c9b1496d%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=d0EtIhNWr5f9kvIOSrRiyQVWGXX4mCNib52U%2FOlE%2B%2Bg%3D&reserved=0.

Yes we are, take a look at the first screenshot. Chris was commenting about the placement of the link to that tabbed document next to the (BETA) text :)

@cwhitten cwhitten merged commit 5cba949 into master Apr 25, 2019
@cwhitten cwhitten deleted the jwilaby/debugging-doc branch April 25, 2019 22:32
Copy link
Contributor

@tonyanziano tonyanziano left a comment

Choose a reason for hiding this comment

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

:shipit: :shipit: :shipit:

@mewa1024
Copy link

@cwhitten I was thinking the sidecar doc would be more like this and that we could leave the Welcome page as is:

sample debugging doc

@cwhitten
Copy link
Member

@mewa1024 Recall our discussion that much of the Welcome Page interactions are specific to both .bot files and Emulator mode. We decided that hiding these elements was the right thing to do and replacing it with a link that would open up documentation in a new tab (like VSCode) on how to get started in the debug mode. I don't think we should mix product functionality (Open bot) with reference material in this sense. This is living, editable documentation that is markdown. This is how VSCode does their release notes & their tabbed material via their help menu. We can start doing the same.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants