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

Add user guide and Discord to GUI help menu #3437

Merged
merged 4 commits into from
Sep 17, 2021

Conversation

HebaruSan
Copy link
Member

@HebaruSan HebaruSan commented Aug 19, 2021

Motivation

CKAN has a pretty detailed user guide that answers most questions users might have. We frequently handle support questions by posting links to it:

However, GUI's help menu shows only:

image

This means the user guide isn't discoverable, and the help menu doesn't provide help!

Changes

Now new menu items in the Help menu link to the user guide and CKAN Discord:

image

Hopefully this will mean that users seeking help will find the user guide and see their questions answered within it. If not, they can ask questions on Discord.

Questions

Is "User guide" clear enough that a user would click on it? Checking a few older Windows applications, they use Help → View Help to open their main help documentation, which we could do as well.

image

@HebaruSan HebaruSan added Enhancement New features or functionality Easy This is easy to fix GUI Issues affecting the interactive GUI Pull request labels Aug 19, 2021
@HebaruSan HebaruSan added the Documentation Issues affecting documentation label Aug 19, 2021
@vinix38
Copy link
Contributor

vinix38 commented Aug 19, 2021

Hi, I'm away from home currently, could you add the French translation for me? "User guide" --> "guide d'utilisation" (If you change your mind, I can adapt the translation, just @ me)
EDIT : Just had a thought, do you think it would possible/useful to translate the documentation ? It might be pushing it, but I was wondering :)

@HebaruSan
Copy link
Member Author

Hi, I'm away from home currently, could you add the French translation for me? "User guide" --> "guide d'utilisation" (If you change your mind, I can adapt the translation, just @ me)

Sounds good, I'll add that. Thanks!

EDIT : Just had a thought, do you think it would possible/useful to translate the documentation ? It might be pushing it, but I was wondering :)

If you are interested in producing a French version of the user guide, I think that would be fantastic, and we would find a way to fit it into the wiki somehow.

@HebaruSan

This comment has been minimized.

@HebaruSan HebaruSan changed the title Add user guide to GUI help menu Add user guide and Discord to GUI help menu Sep 17, 2021
@DasSkelett
Copy link
Member

Is "User guide" clear enough that a user would click on it? Checking a few older Windows applications, they use Help → View Help to open their main help documentation, which we could do as well.

I'm fine with "User guide", it gives a better hint on what to expect than a generic "View Help", which could be anything from a two sentence "click buttons to install" to a multi-volume essay.
Also fits better if we ever add a second link to a different "help" (like a multi-volume essay...)

Copy link
Member

@DasSkelett DasSkelett left a comment

Choose a reason for hiding this comment

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

Excellent idea 👍

@HebaruSan HebaruSan merged commit c3364ec into KSP-CKAN:master Sep 17, 2021
@HebaruSan HebaruSan deleted the feature/help-user-guide branch September 17, 2021 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues affecting documentation Easy This is easy to fix Enhancement New features or functionality GUI Issues affecting the interactive GUI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants