Skip to content

Commit

Permalink
adding Release Candidate release notes and instructions for local ins…
Browse files Browse the repository at this point in the history
…tall
  • Loading branch information
tconfrey committed Apr 3, 2024
1 parent 799c141 commit b0f5354
Show file tree
Hide file tree
Showing 7 changed files with 94 additions and 1 deletion.
Binary file added media/BT-Buddy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/Release-Candidate-TG.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/extensionPage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 44 additions & 0 deletions support/localInstall.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: Local Install
description: How to run BT from the source
layout: default
tagline: The Topic Manager for your Online Life
audience: user
---

# Local Install
## Background
BrainTool is composed of two parts. The BT Extension that you downloaded from the App Store is code that's installed in the browsers extension system. It controls the BT icon in the toolbar and the Bookmarker popup window. It also listens for messages from the BT Topic Manager App and updates tabs accordingly and it sends back event notifications when tabs and windows open or change. On launch the popup code opens a browser tab to the braintool.org website. That tab displays the Topic Manager which is where the main logic of the application lives.

The contents of the extension, the app and the braintool.org website are stored in github. The extension components are bundled up for the latest version of BT and submitted to Google (or Microsoft for Edge) in order to be available on the App Store, everything else is generously hosted by github served up from the repository.

## To Start
In order to run a version of BT other than the App Store version you need to enable Developer mode on your browsers extension page and load an 'unpacked' version of the extension. The extensions page is reached by opening a tab to chrome://extensions, edge://extensions, or brave://extensions based on your browser type.

<img src="../media/extensionPage.png" alt="BT Buddy" style="border:solid; border-width:thin; width:50%; margin-left:5rem;">

## Caution!
Note that these instructions will install the BrainTool Release Candidate as a new extension. On your extensions page you can optionally turn off the 0.9.9 version of BT if you have it installed. Any previous BrainTool data or preferences will not be transferred. I recommend exporting and saving a copy of your BT data (Export under Actions) before installing the new extension. The export can be used to upload your data into the new extension after you install it if you wish.

If you sync your data to a GDrive or local file use caution and create backups to ensure you don't loose any data. GDrive syncing will use the same BrainTool.org file across browsers and extensions based on your Google account. Local file syncing can be pointed to the same file across versions but you can also create a new file, in a different folder.

## Run the Release Candidate via download
The easiest way to run the Release Candidate is to download the extension from this page and uncompress it into a local folder. Then click the 'Load unpacked' button on the extensions page and navigate to the folder. That will install the BrainTool 1.0 extension into your browser, you should see the Welcome page open and then be able to pin the BT 1.0 icon from the browser extensions panel.

[Download the extension file here](https://github.com/tconfrey/BrainTool/raw/master/versions/Release-Candidate/RCextension.zip)
## Run the Release Candidate from the repository
If you run [git](https://git-scm.com/) you can clone the BrainTool repo from [here](https://github.com/tconfrey/BrainTool). Then select the Braintool/versions/Release-Candidate/extension folder when you click the 'Load unpacked' button. Note that this scenario still loads the Topic Manager code from the braintool.org site (hosted by github) and will automatically get any changes pushed to the repo.

## Run any version of BrainTool from a local server
Clone the repo as above. The latest versions of the extension and app are under the top level /extension and /app folders, all other versions are under /versions , specifically the current App Store version is /versions/0.9.9 and the release candidate is /versions/Release-Candidate.

You will need to edit the manifest.json and popup.js files in the extension folder of the version you want to run (probably versions/Release-Candidate/extension). In manifest.json change this row:<br/>
`"matches": ["https://BrainTool.org/versions/Release-Candidate/*"],`<br/>
to match the url from wherever you will run your server, eg:<br/>
`"matches": [const url = "https://localhost:8000/versions/Release-Candidate/*"]`<br/>
And in popup.js find the windowOpen function and edit the url constant from something like this:<br/>
`const url = "https://BrainTool.org/versions/Release-Candidate/app/";`<br/>
to something like this:<br/>
`const url = "https://localhost:8000/versions/Release-Candidate/app/";`<br/>

Install the unpacked extension as described above, run a local server from the top level BrainTool folder and launch the extension.
49 changes: 49 additions & 0 deletions support/releaseNotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,55 @@ tagline: The Topic Manager for your Online Life
audience: user
---

# 1.0 Release Candidate
**Note that the Release Candidate is currently available by invitation only**. See below for 0.9.9a Release Notes. The [discussion group](https://groups.google.com/u/0/g/braintool-discussion) has more details.

This is an early release candidate of the 1.0 version of BrainTool (finally!). It has some significant functional changes and also migrates BT to the latest 'Manifest V3' version of the Chromium browser extension architecture. Given the scale of changes a select user group is being asked to manually install this version and provide feedback. See [Installing BrainTool from source](localInstall) for how to do that.

## Manifest V3
This change is not of great interest to a BT user but is mandated by Google (see this [notice](https://developer.chrome.com/blog/resuming-the-transition-to-mv3)) and required non-trivial code changes.

## Full Tab Group Support
One advantage of the manifest update is that it provides access to the tabgroup api so that BT can provide full synchronization between Topics and browser tabgroups. By default Topics are now represented by tabgroups. Tabs opened from BT open in a tabgroup labelled with the appropriate Topic. In the Topic Manager opened links and Topics are highlighted with the tabgroups color. Changing the tabgroups color in the browser is reflected in the Topic Manager. Name changes and expand/collapse operations are synced.

Additionally dragging a tab into a tabgroup will save that tab into the Topic in BT. Dragging a saved tab out of its tabgroup will remove it from BrainTool.
![TabGroups](../media/Release-Candidate-TG.png)
## Session saving and Bookmarker Updates
The BT Bookmarker now has the option to save a whole tabgroup (if the current tab is in one), and a complete session, in addition to the previous window and tab options. When saving a session, tab groups are saved as the corresponding BrainTool Topic. Any ungrouped tabs are put in a tabgroup named with a Window-N prefix and saved under a Topic with the same name in the Topic Manager. The Session itself is given a Session-date Topic name and saved under the Topic selected in the Bookmarker or the Scratch default Topic.

## Preferences for Dense, Hide Notes and Large Font
New preferences have been added for these items.

## New Introductory Screens

<div class="row">
<div class="cell left" style="text-align:justify; width: 30%">
We've added a helpful BrainTool Buddy to give a gentle introduction to BT when it's initially installed and at launch thereafter, until turned off on the final screen.
</div>
<div class="cell right" style="width: 70%">
<img src="../media/BT-Buddy.png" alt="BT Buddy" style="border:solid; border-width:thin; width:60%; margin-left:2rem;">
</div>
</div>
## GDrive Auth Change
Another Google mandated update is the change to use their [Auth 2.0](https://developers.google.com/identity/oauth2/web/guides/migration-to-gis) libraries for Google Drive authorization. Unfortunately the access provided to browser-based apps (ie those without a back-end server) is considered to be temporary access and to require explicit user interaction. As a result if you have GDrive saving turned on you will now need to walk through a Google popup every hour to grant BrainTool access. From my perspective the change renders this BT feature pretty unusable but I'm interested in feedback.

## Usability Improvements
- Rows in the Topic Manager can now be dragged by selecting anywhere on the row
- The Tab key now iterates a selected Topic through three states: collapsed, open with its child nodes showing and open with its children all fully expanded.
- Search has been improved to make it easier to see the current match and other visible matches.

## Pricing and License Changes
While not yet visible in the Release Candidate I'd appreciate feedback on these planned changes:
- There will be no limits on numbers of nodes saved in BT (other than those due to browser storage limits)
- In addition to monthly and yearly subscriptions a single purchase lifetime license will be offered with pricing as follows:
- Monthly $1.33/mo, Yearly $10.66/yr, Lifetime $20.99
- This (low, low) pricing reflects my goal of having BT be widely used and to encourage users to support its development. The extra change over $1/$10/$20 covers the Stripe transaction costs.
- License enforcement will be as follows:
- 30 days all access.
- After 30 days messages of gentle encouragement will be shown at intervals.
- Functionally some setting preferences will be locked (Dark mode, Favicons etc) but otherwise the app will be fully functional.


# Welcome to 0.9.9a
This is a minor point release because there are no changes requiring updates on the Web Stores, but it has some major functionality! In addition to releasing some ongoing UI improvements my goal with 099a is to get feedback on the beta version of local file syncing. I have not been able to test this functionality across a wide set of environments so I'm considering it in beta and encouraging anyone interested to give it a try and let me know (via the [discussion group](https://groups.google.com/u/0/g/braintool-discussion) ) if you have any feedback (positive or negative).

Expand Down
2 changes: 1 addition & 1 deletion support/userGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ audience: user
---

# User Guide
BrainTool is a 'Topic' Manager. Topics are the basic unit of organization. The BrainTool Topic Manager shows your topic hierarchy and provides tools for editing and curating your topics. The BrainTool Saver lets you quickly assign a topic to any web page or resource that you want to keep track of.
BrainTool is a 'Topic' Manager for your tabs. Topics are the basic unit of organization. The BrainTool Topic Manager shows your topic hierarchy and provides tools for editing and curating your topics. The BrainTool Saver lets you quickly assign a topic to any web page or resource that you want to keep track of.
<div class="row">
<div class="cell left">
<img src="/site/TopicManager.png" alt="side-panel" style="border:solid; border-width:thin; width:80%">
Expand Down
Binary file added versions/Release-Candidate/RCextension.zip
Binary file not shown.

0 comments on commit b0f5354

Please sign in to comment.