wikitree / wikitree-browser-extension

Browser extension that adds advanced features to WikiTree.com.
MIT License
25 stars 20 forks source link

Directions for users to configure extension #152

Closed ke4tch closed 1 year ago

ke4tch commented 1 year ago

The G2G thread about the new extension has questions from users (of both Chrome and Firefox) about how to configure the extension.

We should have some concise, simple directions for configuration.

Where should this go? If they haven't figured out how to install the extension, it can't go in the extension. A G2G post would get stale very quickly. So the extension is separate from the core, but should there be some basic help about how to find, install, and open configuration page for the extension on the Help pages?

shogenapps commented 1 year ago

I've updated the space page with more information. Feel free to add to it or edit it. Yes, I think there should be something about the extension on Help pages and (definitely) on the Apps page.

jmegenealogy commented 1 year ago

I'll create a basic Help page (so people can find it when searching the Help pages), and link to the Space page from there.

Most details should be on the Space page (since only Leaders/Sysops can edit the Help pages) -- so any suggestions on what I should put on the Help page?

Help page is here: https://www.wikitree.com/wiki/Help:WikiTree_Browser_Extension

ke4tch commented 1 year ago

I would recommend something like, well, its a really rough draft

If you are using a Chrome browser or any of the following browsers Opera, Edge, Brave, and Vivaldi:

  1. Install the extension blah blah
  2. To configure the installed extension:
    • click the tool icon in the upper right corner of the browser window
    • under Extensions click on the three ... by WikiTree Browser Extension and then click Manage Extension
    • on the page for the extension scroll down and click on Extension Options.
    • on the WikiTree Extension options page click the button(s) to turn feature(s) on or off

If you are using the Firefox browser:

  1. From the Tools menu in the Firefox top toolbar, select Add-ons and Themes
  2. Search for WikiTree Browser to find the extension, then click on the WikiTree Browser Extension to install it
  3. The Tools->Add-ons and Themes menu opens your Manage Your Extensions page. From this page, click on the ... next to WikiTree Browser Extension
  4. Click Manage to see what version you have and to see the release notes
  5. Click Preferences to open the Extension Options page
    • on the WikiTree Extension options page click the button(s) to turn feature(s) on or off
RobPavey commented 1 year ago

The way I configure the Chrome extension is a different way which seems easier to me:

After installing:

Each time you want to edit configuration:

Or if you don't want to pin it (this skips a step from Kay's instructions):

Lesko987 commented 1 year ago

I think extension deserves a link from the main WikiTree Menus. Maybe under Help / Extension.

It could link to Chrome store, but that is a problem for Firefox and IOS. Next best thing would be a Help:Extension page with links to all three stores and some First steps for each browser. Steve, Jamie and me can update the page as necessary. And there would also be links to Space pages with detailed descriptions.

shogenapps commented 1 year ago

Why not just link the help page to the space page and improve that?

shogenapps commented 1 year ago

Sorted.