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

Clarify and replace menu screenshot #7

Open
tedepstein opened this issue Sep 26, 2018 · 3 comments
Open

Clarify and replace menu screenshot #7

tedepstein opened this issue Sep 26, 2018 · 3 comments

Comments

@tedepstein
Copy link

tedepstein commented Sep 26, 2018

@andylowry wrote:

Tanya, I added a screnshot in #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

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:

image

... 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

@andylowry
Copy link
Contributor

andylowry commented Sep 26, 2018 via email

@tedepstein
Copy link
Author

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.

@tedepstein
Copy link
Author

I just made a correction to my initial comment above:

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:

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.

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

No branches or pull requests

2 participants