Skip to content
This repository has been archived by the owner. It is now read-only.
Permalink
Browse files
Point all references to https://github.com/mozilla-services/pageshot
…to /screenshots
  • Loading branch information
ianb committed Mar 22, 2017
1 parent 41d6a44 commit 58b35fbf992cbf8ea1b4c7f1dcb7a65ffd5e6479
Showing with 201 additions and 201 deletions.
  1. +153 −153 CHANGELOG.md
  2. +12 −12 README.md
  3. +1 −1 addon/webextension/manifest.json.template
  4. +2 −2 bin/generate-commit-log
  5. +5 −5 docs/METRICS.md
  6. +11 −11 docs/acceptance.md
  7. +4 −4 docs/deployment.md
  8. +1 −1 docs/testing-the-api.md
  9. +2 −2 package.json
  10. +1 −1 server/src/footer-view.js
  11. +1 −1 server/src/pages/homepage/view.js
  12. +8 −8 server/src/server.js

Large diffs are not rendered by default.

@@ -20,13 +20,13 @@ Install [Postgres](http://www.postgresql.org/).

Install [Node.js](https://nodejs.org/). Version 6.x is required.

Clone the [repository](https://github.com/mozilla-services/pageshot/).
Clone the [repository](https://github.com/mozilla-services/screenshots/).

There are two scripts to run the server locally and develop the add-on:

- `./bin/run-server` will run the server on `http://localhost:10080` and automatically restart if there are changes.
- `./bin/run-addon` will build a few parts of the addon (into `addon/webextension/build/`) and start Firefox with the add-on installed. The add-on will be refreshed automatically as you change files. We recommend you open `about:debugging` to help debug the extension.
- - `./bin/run-addon --bootstrap` will run the add-on using the [bootstrap](https://github.com/mozilla-services/pageshot/blob/master/addon/bootstrap.js) wrapper. This is how the add-on is run in Firefox, and provides some additional services, like Telemetry and migration. This does not support reloading, so if you aren't developing things involving the wrapper then you can run without `--bootstrap`.
- - `./bin/run-addon --bootstrap` will run the add-on using the [bootstrap](https://github.com/mozilla-services/screenshots/blob/master/addon/bootstrap.js) wrapper. This is how the add-on is run in Firefox, and provides some additional services, like Telemetry and migration. This does not support reloading, so if you aren't developing things involving the wrapper then you can run without `--bootstrap`.
- `./bin/run-addon --setup-profile` will setup a Firefox profile for your development; this way you can make persistent changes to the profile that you will use just for Screenshots development. (note: this will only look for the `firefox` commmand or Nightly, Developer Edition, Aurora editions on OSX)

**If you want to develop the add-on but not the server** you can run `./bin/run-addon -s https://pageshot.dev.mozaws.net`
@@ -41,23 +41,23 @@ We apologize but we have no story for development on Windows (though the add-on

### Getting to know the code

There is documentation in [addon/](https://github.com/mozilla-services/pageshot/blob/master/addon/), [addon/webextension/](https://github.com/mozilla-services/pageshot/blob/master/addon/webextension/), [addon/webextension/background/](https://github.com/mozilla-services/pageshot/blob/master/addon/webextension/background/), and [addon/webextension/selector/](https://github.com/mozilla-services/pageshot/blob/master/addon/webextension/selector) that talks about the code layout and architecture of the add-on.
There is documentation in [addon/](https://github.com/mozilla-services/screenshots/blob/master/addon/), [addon/webextension/](https://github.com/mozilla-services/screenshots/blob/master/addon/webextension/), [addon/webextension/background/](https://github.com/mozilla-services/screenshots/blob/master/addon/webextension/background/), and [addon/webextension/selector/](https://github.com/mozilla-services/screenshots/blob/master/addon/webextension/selector) that talks about the code layout and architecture of the add-on.

[server/view-docs.md](https://github.com/mozilla-services/pageshot/blob/master/server/views-docs.md) talks about how the server React pages are setup, along with the server-side rendering of pages.
[server/view-docs.md](https://github.com/mozilla-services/screenshots/blob/master/server/views-docs.md) talks about how the server React pages are setup, along with the server-side rendering of pages.

There is also documentation in [docs/](https://github.com/mozilla-services/pageshot/blob/master/docs/).
There is also documentation in [docs/](https://github.com/mozilla-services/screenshots/blob/master/docs/).

### Participation

There is an IRC channel `#pageshot` on irc.mozilla.org (you can use [this link](https://kiwiirc.com/client/irc.mozilla.org/pageshot) for chat access via the web if you do not otherwise use IRC). There are [IRC logs available](http://logs.glob.uno/?c=pageshot).

Planning and ideation is happening in the [issue tracker](https://github.com/mozilla-services/pageshot/issues). We have several [milestones](https://github.com/mozilla-services/pageshot/milestones):
Planning and ideation is happening in the [issue tracker](https://github.com/mozilla-services/screenshots/issues). We have several [milestones](https://github.com/mozilla-services/screenshots/milestones):

* [Issues with no milestone](https://github.com/mozilla-services/pageshot/issues?q=is%3Aopen+is%3Aissue+no%3Amilestone) are awaiting triage
* [Issues in Stretch](https://github.com/mozilla-services/pageshot/milestone/9) are immediately actionable but just nice-to-haves, not blockers.
* [Issues in Next Tasks](https://github.com/mozilla-services/pageshot/milestone/2) are deferred for now, but will be re-triaged when the current milestone is done
* [Issues in Blue Sky](https://github.com/mozilla-services/pageshot/milestone/3) are mostly shelved; we'd like to do them but have no plans to move forward. (If you see something you care about there, comment on it -- otherwise we may not notice it)
* [Issues in 54](https://github.com/mozilla-services/pageshot/milestone/20) are things we want to do to ship to a general Firefox audience.
* [Issues with no milestone](https://github.com/mozilla-services/screenshots/issues?q=is%3Aopen+is%3Aissue+no%3Amilestone) are awaiting triage
* [Issues in Stretch](https://github.com/mozilla-services/screenshots/milestone/9) are immediately actionable but just nice-to-haves, not blockers.
* [Issues in Next Tasks](https://github.com/mozilla-services/screenshots/milestone/2) are deferred for now, but will be re-triaged when the current milestone is done
* [Issues in Blue Sky](https://github.com/mozilla-services/screenshots/milestone/3) are mostly shelved; we'd like to do them but have no plans to move forward. (If you see something you care about there, comment on it -- otherwise we may not notice it)
* [Issues in 54](https://github.com/mozilla-services/screenshots/milestone/20) are things we want to do to ship to a general Firefox audience.
* Look for "Sprint 54.x" to see planned work for a sprint (2-week phase)

Issue tags otherwise aren't very structured. [Research](https://github.com/mozilla-services/pageshot/issues?q=is%3Aopen+is%3Aissue+label%3Aresearch) is primarily analysis of other products that do something interesting, or some source material that could provide insight. Input on these (things like "I like this product because...") is very helpful!
Issue tags otherwise aren't very structured. [Research](https://github.com/mozilla-services/screenshots/issues?q=is%3Aopen+is%3Aissue+label%3Aresearch) is primarily analysis of other products that do something interesting, or some source material that could provide insight. Input on these (things like "I like this product because...") is very helpful!
@@ -4,7 +4,7 @@
"version": "__VERSION__",
"description": "__MSG_addonDescription__",
"author": "__MSG_addonAuthorsList__",
"homepage_url": "https://github.com/mozilla-services/pageshot",
"homepage_url": "https://github.com/mozilla-services/screenshots",
"applications": {
"gecko": {
"id": "screenshots@mozilla.org"
@@ -57,8 +57,8 @@ for message in messages:
if not full.endswith("."):
full += "."
full = full + "".join(found)
full = full + " [%s](https://github.com/mozilla-services/pageshot/commit/%s)" % (short, short)
full = issue_regex.sub(r'[#\1](https://github.com/mozilla-services/pageshot/issues/\1)', full)
full = full + " [%s](https://github.com/mozilla-services/screenshots/commit/%s)" % (short, short)
full = issue_regex.sub(r'[#\1](https://github.com/mozilla-services/screenshots/issues/\1)', full)
parts.append(full)

parts = "\n".join(parts)
@@ -41,7 +41,7 @@ first_created | last_created

We're not sure how to aggregate this in SQL, but we can always do it in the server. We might want look at all cohorts or just some cohorts, and account for the current day.

(Work listed and finished in [#1197](https://github.com/mozilla-services/pageshot/issues/1197))
(Work listed and finished in [#1197](https://github.com/mozilla-services/screenshots/issues/1197))

#### Do people share those shots with other people?

@@ -69,7 +69,7 @@ This information is intended to help us make Firefox Screenshots better.

We record an event stream of interaction with the add-on and website. The events:

(**Note**: per [#1183](https://github.com/mozilla-services/pageshot/issues/1183) we need to figure out if we are actually collecting these events properly)
(**Note**: per [#1183](https://github.com/mozilla-services/screenshots/issues/1183) we need to figure out if we are actually collecting these events properly)

### Metrics schema

@@ -92,21 +92,21 @@ Event label: exactly what control invoked the action, such as toolbar-button. T

##### Highlight shot button

As described in [#2081](https://github.com/mozilla-services/pageshot/issues/2081) we are putting a badge on the button of some users. The test is named `highlightButtonOnInstall`.
As described in [#2081](https://github.com/mozilla-services/screenshots/issues/2081) we are putting a badge on the button of some users. The test is named `highlightButtonOnInstall`.

The dimension `cd3` will be `control` (no badge) or `badge` (10% of population).

If the badge is shown we send the event `addon/ab-highlight-button-shown` – this is marked as a non-interactive event.

##### Adjust My Shots button display

As described in [#2082](https://github.com/mozilla-services/pageshot/issues/2082) we are changing how the My Shots button is displayed. The test is named `styleMyShotsButton`.
As described in [#2082](https://github.com/mozilla-services/screenshots/issues/2082) we are changing how the My Shots button is displayed. The test is named `styleMyShotsButton`.

The dimension `cd4` will be `control` (normal styling) or something else Yet To Be Determined.

##### Auto-open share panel

As described in [#2079](https://github.com/mozilla-services/pageshot/issues/2079) we auto-open the share panel for a set of users. The test is named `autoOpenSharePanel`.
As described in [#2079](https://github.com/mozilla-services/screenshots/issues/2079) we auto-open the share panel for a set of users. The test is named `autoOpenSharePanel`.

The dimension `cd5` *for the creator* will be `control` (no auto-opening) or `autoopen` (share panel will be auto-opened). The dimension `cd6` will be `control` (no auto-opening *happened*) or `autoopen` (auto-open happened in the past at shot creation).

@@ -6,29 +6,29 @@ triaged into sprints on a an as-needed basis. Items in this list may not
correlate with issues on a 1:1 basis.

# General
- [ ] Build DMCA capabilities [#2288](https://github.com/mozilla-services/pageshot/issues/2288)
- [ ] Support Localization [#2205](https://github.com/mozilla-services/pageshot/issues/2205)
- [ ] Build DMCA capabilities [#2288](https://github.com/mozilla-services/screenshots/issues/2288)
- [ ] Support Localization [#2205](https://github.com/mozilla-services/screenshots/issues/2205)

## Add-on Activation
- [ ] It should be able to be progressively revealed/enabled by the shield recipe server [#2332](https://github.com/mozilla-services/pageshot/issues/2332)
- [ ] It should be able to be enabled and disabled by a toggle in about:preferences [#2333](https://github.com/mozilla-services/pageshot/issues/2333)
- [ ] It should be able to be progressively revealed/enabled by the shield recipe server [#2332](https://github.com/mozilla-services/screenshots/issues/2332)
- [ ] It should be able to be enabled and disabled by a toggle in about:preferences [#2333](https://github.com/mozilla-services/screenshots/issues/2333)

# UI/UX

## General UI Revisions (ADDON + SERVER)
- [ ] It should have a new logo and word mark that match Photon
- [ ] It should have an overall color system that matches Photon
- [ ] It should have buttons, inputs, controls etc. that match Photon
- [ ] It should use the new Mozilla logo [#2211](https://github.com/mozilla-services/pageshot/issues/2211)
- [ ] It should use the new Mozilla logo [#2211](https://github.com/mozilla-services/screenshots/issues/2211)
- [ ] All images should be SVG or have retina versions
- [ ] It should undergo an accessibility review prior to launch [#2251](https://github.com/mozilla-services/pageshot/issues/2251)
- [ ] It should undergo an accessibility review prior to launch [#2251](https://github.com/mozilla-services/screenshots/issues/2251)
- [ ] It should have a new name
- [ ] It should be at screenshots.firefox.com [Bug 1347251](https://bugzilla.mozilla.org/show_bug.cgi?id=1347251)

## Shot iframe (ADDON)
- [ ] It should match the final spec provided by the UX team [#2306](https://github.com/mozilla-services/pageshot/issues/2306)
- [ ] It should match the final spec provided by the UX team [#2306](https://github.com/mozilla-services/screenshots/issues/2306)

## Shots Index Page UI (SERVER) [#2308](https://github.com/mozilla-services/pageshot/issues/2308)
## Shots Index Page UI (SERVER) [#2308](https://github.com/mozilla-services/screenshots/issues/2308)
- [ ] It should match the final spec provided by UX team
- [ ] It should include the ability to download, copy link, delete and access to shot page for each shot
- [ ] It should make use of the CSS grid spec [NB. This is an odd requirement, but we are only supporting Firefox 54+ and unspecified future releases of Chrome. Shipping CSS grid at a large scale will give us a good Hacks post, and won’t be particularly costly given what I’ve seen of the spec]
@@ -63,7 +63,7 @@ correlate with issues on a 1:1 basis.
## Non-Owner Specific Expired Page UI
- [ ] It should include promotional materials describing the utility of Firefox Screenshots and link to the landing page

## Landing Page UI [#2310](https://github.com/mozilla-services/pageshot/issues/2310)
## Landing Page UI [#2310](https://github.com/mozilla-services/screenshots/issues/2310)
- [ ] It should match the final spec provided by the UX team
- [ ] It should describe the value proposition of Firefox Screenshots
- [ ] It should specify that Firefox Screenshots is currently only available for Firefox on Desktop for non-FF users
@@ -72,7 +72,7 @@ correlate with issues on a 1:1 basis.
- [ ] It should accomodate different messaging based on state of phased roll out
- [ ] *STRETCH:* it should let users of Firefox 54 + trigger the add-on onboarding flow from the site

## Onboarding UI [#2307](https://github.com/mozilla-services/pageshot/issues/2307)
## Onboarding UI [#2307](https://github.com/mozilla-services/screenshots/issues/2307)
- [ ] It should match the final spec provided by the UX team
- [ ] It should proceed stepwise to explain the basics of the Screenshots feature
- [ ] It should initially suggest itself by adding a Screenshots icon to the tool bar and badging it
@@ -81,7 +81,7 @@ correlate with issues on a 1:1 basis.
# Measurements & Dashboards

## Measures
- [ ] Reporting of all measures should be derived from the state of the Telemetry flag in the browser. [#2250](https://github.com/mozilla-services/pageshot/issues/2250)
- [ ] Reporting of all measures should be derived from the state of the Telemetry flag in the browser. [#2250](https://github.com/mozilla-services/screenshots/issues/2250)
- [ ] It should have a documented plan for testing and verifying all new measures.
- [ ] All measures currently in the product should be audited to ensure they’re working as intended.
- [ ] Onboarding UI should be instrumented to measure interaction rate w/buttons/controls etc.
@@ -15,7 +15,7 @@ Softvision is our embedded QA team. Their main functions are to write test plans

## Team Notification ##

During the checkin before the end of the [current milestone](https://github.com/mozilla-services/pageshot/milestones), we will inform the team that we will be building a release against `master`.
During the checkin before the end of the [current milestone](https://github.com/mozilla-services/screenshots/milestones), we will inform the team that we will be building a release against `master`.

Note: we deploy the master branch to our *development environment*: [http://pageshot.dev.mozaws.net](https://pageshot.dev.mozaws.net)

@@ -29,7 +29,7 @@ Use `bin/commit-new-version x.y.0` to set versions in package.json, tag the rele

This will happen on Friday after any style tweaks land.

1. https://github.com/mozilla-services/pageshot/releases/new
1. https://github.com/mozilla-services/screenshots/releases/new
3. Release Title: x.y.0
4. Click `Publish`

@@ -61,7 +61,7 @@ You can install the stage version of the add-on from https://pageshot.stage.moza

This will happen on Friday at the end of sprint after we've pushed to stage.

Create a deployment issue to track status and potential blockers. Give it a [needs:qa label](https://github.com/mozilla-services/pageshot/issues?utf8=✓&q=is%3Aissue%20is%3Aopen%20label%3A%22needs%3Aqa%22%20).
Create a deployment issue to track status and potential blockers. Give it a [needs:qa label](https://github.com/mozilla-services/screenshots/issues?utf8=✓&q=is%3Aissue%20is%3Aopen%20label%3A%22needs%3Aqa%22%20).

Send out an email notification to `testpilot-dev@mozilla.org` to please test the staging environment.

@@ -117,7 +117,7 @@ The application server can manage upgrades of the database. It can also handle

Rollback requires deploying the *newest* version of the application and setting an environmental variable to request it to downgrade.

For instance, if you want to install version 1.0.1, you'd look in [dbschema](https://github.com/mozilla-services/pageshot/blob/1.0.1/server/src/dbschema.js#L7) and see `const MAX_DB_LEVEL = 10;` – but let's say the current database version is 12. If you look in [server/db-patches](https://github.com/mozilla-services/pageshot/tree/1.0.1/server/db-patches) for version 1.0.1 there's no patch files to make that change. There *are* [necessary patches in master](https://github.com/mozilla-services/pageshot/tree/master/server/db-patches).
For instance, if you want to install version 1.0.1, you'd look in [dbschema](https://github.com/mozilla-services/screenshots/blob/1.0.1/server/src/dbschema.js#L7) and see `const MAX_DB_LEVEL = 10;` – but let's say the current database version is 12. If you look in [server/db-patches](https://github.com/mozilla-services/screenshots/tree/1.0.1/server/db-patches) for version 1.0.1 there's no patch files to make that change. There *are* [necessary patches in master](https://github.com/mozilla-services/screenshots/tree/master/server/db-patches).

Therefore to deploy an old version *first* you must deploy a recent version and ask it to downgrade the database. Downgrading can be requested through an environmental variable:

@@ -64,7 +64,7 @@ Authenticated. Creates or updates a shot. Takes a JSON body. Looks like:
```json
{
"deviceId": "anonf54641fa-ea19-3648-ba07-10c98d13726e",
"url": "https://github.com/mozilla-services/pageshot/issues/1237",
"url": "https://github.com/mozilla-services/screenshots/issues/1237",
"docTitle": "Screenshots erases everything in my clipboard · Issue #1237 · mozilla-services/pageshot",
"createdDate": 1468983767525,
"favicon": "https://assets-cdn.github.com/favicon.ico",
@@ -4,7 +4,7 @@
"version": "5.2.0",
"author": "Mozilla (https://mozilla.org/)",
"bugs": {
"url": "https://github.com/mozilla-services/pageshot/issues"
"url": "https://github.com/mozilla-services/screenshots/issues"
},
"dependencies": {
"atob": "2.0.3",
@@ -63,7 +63,7 @@
"license": "MPL-2.0",
"repository": {
"type": "git",
"url": "git+https://github.com/mozilla-services/pageshot.git"
"url": "git+https://github.com/mozilla-services/screenshots.git"
},
"scripts": {
"lint": "npm-run-all lint:*",

0 comments on commit 58b35fb

Please sign in to comment.