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

Create documentation for users so they can easily install hypothes.is #21

Closed
raquelalegre opened this issue Dec 1, 2020 · 2 comments
Closed
Assignees
Labels
Comments Documentation Improvements or additions to documentation Hypothes.is Technical

Comments

@raquelalegre
Copy link
Contributor

raquelalegre commented Dec 1, 2020

Perhaps using readthedocs?

@raquelalegre raquelalegre added Documentation Improvements or additions to documentation Technical To Do Comments Hypothes.is labels Dec 1, 2020
@raquelalegre raquelalegre self-assigned this Dec 1, 2020
@raquelalegre raquelalegre removed the To Do label Dec 1, 2020
@raquelalegre
Copy link
Contributor Author

Some documentation can be extracted from the text in this email:

  1. The commentary functionality is done with a third-party tool called Hypothes.is. You can create an account here: https://hypothes.is/signup
  2. You will need to install this Chrome extension to use it: https://chrome.google.com/webstore/detail/hypothesis-web-pdf-annota/bjfhmglciegochdpefhhlphglcehbmek
  3. In order to keep the comments of the team separated from those you'd like the advisory board to be able to see, we have created two groups. You can join both following the links below:
    1. FRRAnt Team: https://hypothes.is/groups/WL2PzQEp/frrant-team
    2. FRRAnt Advisory Board: https://hypothes.is/groups/eidwEMw7/frrant-advisory-board
  4. Navigate to www.ucl.ac.uk/frrant and choose the relevant group in the Chrome extension you want to make comments to. The "Public" group is always there by default, but you can ignore it unless you want to make your comments visible by anyone with a Hypothes.is extension who browses the website.
  5. Select any piece of text in the website and you should see a popup with an option to annotate. You should be able to create comments on the extension from there on.

@raquelalegre
Copy link
Contributor Author

Duplication from #16.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Comments Documentation Improvements or additions to documentation Hypothes.is Technical
Projects
None yet
Development

No branches or pull requests

1 participant