forked from mirrors/gecko-dev
Bug 1866802 - Update documentation for the ASRouter and Discovery Stream devtools. r=pdahiya,thecount
Differential Revision: https://phabricator.services.mozilla.com/D195812
This commit is contained in:
parent
ed7d37845a
commit
ff511df662
5 changed files with 17 additions and 12 deletions
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
## How to enable ASRouter devtools
|
## How to enable ASRouter devtools
|
||||||
- In `about:config`, set `browser.newtabpage.activity-stream.asrouter.devtoolsEnabled` to `true`
|
- In `about:config`, set `browser.newtabpage.activity-stream.asrouter.devtoolsEnabled` to `true`
|
||||||
- Visit `about:newtab#asrouter` to see the devtools.
|
- Visit `about:asrouter` to see the devtools.
|
||||||
|
|
||||||
## Overview of ASRouter devtools
|
## Overview of ASRouter devtools
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -403,18 +403,14 @@ export class DiscoveryStreamAdminInner extends React.PureComponent {
|
||||||
<p className="helpLink">
|
<p className="helpLink">
|
||||||
<span className="icon icon-small-spacer icon-info" />{" "}
|
<span className="icon icon-small-spacer icon-info" />{" "}
|
||||||
<span>
|
<span>
|
||||||
Need help using these tools? Check out our{" "}
|
Need to access the ASRouter Admin dev tools?{" "}
|
||||||
<a
|
<a target="blank" href="about:asrouter">
|
||||||
target="blank"
|
Click here
|
||||||
href="https://firefox-source-docs.mozilla.org/browser/components/newtab/content-src/asrouter/docs/debugging-docs.html"
|
|
||||||
>
|
|
||||||
documentation
|
|
||||||
</a>
|
</a>
|
||||||
</span>
|
</span>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<React.Fragment>
|
<React.Fragment>
|
||||||
<h2>Discovery Stream</h2>
|
|
||||||
<DiscoveryStreamAdminUI
|
<DiscoveryStreamAdminUI
|
||||||
state={{
|
state={{
|
||||||
DiscoveryStream: this.props.DiscoveryStream,
|
DiscoveryStream: this.props.DiscoveryStream,
|
||||||
|
|
|
||||||
|
|
@ -891,10 +891,10 @@ class DiscoveryStreamAdminInner extends (external_React_default()).PureComponent
|
||||||
className: "helpLink"
|
className: "helpLink"
|
||||||
}, /*#__PURE__*/external_React_default().createElement("span", {
|
}, /*#__PURE__*/external_React_default().createElement("span", {
|
||||||
className: "icon icon-small-spacer icon-info"
|
className: "icon icon-small-spacer icon-info"
|
||||||
}), " ", /*#__PURE__*/external_React_default().createElement("span", null, "Need help using these tools? Check out our", " ", /*#__PURE__*/external_React_default().createElement("a", {
|
}), " ", /*#__PURE__*/external_React_default().createElement("span", null, "Need to access the ASRouter Admin dev tools?", " ", /*#__PURE__*/external_React_default().createElement("a", {
|
||||||
target: "blank",
|
target: "blank",
|
||||||
href: "https://firefox-source-docs.mozilla.org/browser/components/newtab/content-src/asrouter/docs/debugging-docs.html"
|
href: "about:asrouter"
|
||||||
}, "documentation"))), /*#__PURE__*/external_React_default().createElement((external_React_default()).Fragment, null, /*#__PURE__*/external_React_default().createElement("h2", null, "Discovery Stream"), /*#__PURE__*/external_React_default().createElement(DiscoveryStreamAdminUI, {
|
}, "Click here"))), /*#__PURE__*/external_React_default().createElement((external_React_default()).Fragment, null, /*#__PURE__*/external_React_default().createElement(DiscoveryStreamAdminUI, {
|
||||||
state: {
|
state: {
|
||||||
DiscoveryStream: this.props.DiscoveryStream,
|
DiscoveryStream: this.props.DiscoveryStream,
|
||||||
Personalization: this.props.Personalization
|
Personalization: this.props.Personalization
|
||||||
|
|
|
||||||
|
|
@ -99,6 +99,15 @@ running
|
||||||
./mach npm test --prefix=browser/components/newtab &&
|
./mach npm test --prefix=browser/components/newtab &&
|
||||||
./mach npm run debugcoverage --prefix=browser/components/newtab
|
./mach npm run debugcoverage --prefix=browser/components/newtab
|
||||||
|
|
||||||
|
Discovery Stream Developer tools
|
||||||
|
--------------------------------
|
||||||
|
|
||||||
|
You can access the developer tools for the Discovery Stream components of about:newtab by
|
||||||
|
visiting `about:config` and setting `browser.newtabpage.activity-stream.asrouter.devtoolsEnabled`
|
||||||
|
to `true`.
|
||||||
|
|
||||||
|
Then, go to any `about:newtab` page and click on the wrench icon in the top-right corner.
|
||||||
|
|
||||||
Detailed Docs
|
Detailed Docs
|
||||||
-------------
|
-------------
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
|
|
||||||
|
|
@ -44,7 +44,7 @@ describe("DiscoveryStreamAdmin", () => {
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
it("should render a DS section", () => {
|
it("should render a DS section", () => {
|
||||||
assert.equal(wrapper.find("h2").at(0).text(), "Discovery Stream");
|
assert.equal(wrapper.find("h1").at(0).text(), "Discovery Stream Admin");
|
||||||
});
|
});
|
||||||
|
|
||||||
describe("#DiscoveryStream", () => {
|
describe("#DiscoveryStream", () => {
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue