-
Notifications
You must be signed in to change notification settings - Fork 0
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
Clarify and replace menu screenshot #7
Comments
It's the same menu I showed, but looks very different on Linux. Screenshots
are spare in both demos. I think it's a reasonable assumption that the user
exploring this is reasonably comfortable with the product and doesn't need
a ton of handholding. Going from a different assumption, e.g. like the
codegen intro doc, would make these much longer and a much bigger
investment.
…On Tue, Sep 25, 2018, 9:39 PM Ted Epstein ***@***.***> wrote:
@andylowry <https://github.com/andylowry> wrote:
Tanya, I added a screnshot in #4
<#4> that looks
out-of-place cuz it was done on linux (weird colors). It'd probably be good
for you to replace it with one captured on Mac, so it'll match other
screenshots.
Also, the instruction was not very clear:
Note: if you do not see .openapi-geneator-ignore in your project, you
need to disable the .* resources filter here:
[image: image]
<https://user-images.githubusercontent.com/108675/46030987-ac809b80-c0c5-11e8-969f-9d0eaa143001.png>
The screenshot shows a menu, but it wasn't where I need to click in order
to see that menu. It's the "view menu" button in the Project Explorer:
[image: image]
<https://user-images.githubusercontent.com/692813/46052166-bb397380-c102-11e8-984b-dbe0511cd1a0.png>
... and it would help to show a second screenshot of the Filters &
Customization dialog, showing which tab you need to activate, and which box
to uncheck:
[image: image]
<https://user-images.githubusercontent.com/692813/46052252-18352980-c103-11e8-900f-2778dc9fde4d.png>
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#7>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/AAGog-sjNpkOAnmQIr0rJJQOmB1Qeuu_ks5uetrUgaJpZM4W5wD->
.
|
The problem with the linux screenshot is not that it looks different, but that it doesn't show enough of the screen to see that it's the Project Explorer window where you clicked to get this menu. Also, the buttons at the top of the Project Explorer are small and not very intuitive, so I think it really helps to point out where the user should click to get that menu. It is safe to assume that readers are familiar with the basics of API Studio and OpenAPI. It's definitely not a safe assumption that the people going through these examples are familiar with Eclipse, to the level of detail where they'd know how to find a particular menu or command. |
I just made a correction to my initial comment above:
I had omitted the word 'clear'. I wasn't trying to say that the screenshot showed the wrong menu, just that the screenshot didn't make it clear where the user needs to click in order to show that menu. |
@andylowry wrote:
Also, the instruction was not very clear:
The screenshot shows a menu, but it wasn't clear where I need to click in order to see that menu. It's the "view menu" button in the Project Explorer:
... and it would help to show a second screenshot of the Filters & Customization dialog, showing which tab you need to activate, and which box to uncheck:
The text was updated successfully, but these errors were encountered: