Skip to content

Commit e4c7580

Browse files
jodyheavenerjodyheavener
committed
Add some initial documentation pages and sidebar links
1 parent cfe32d5 commit e4c7580

File tree

6 files changed

+167
-4
lines changed

6 files changed

+167
-4
lines changed

‎docs/data-scientists-root.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
id: data-scientists-root
3+
title: Root Page
4+
slug: /data-scientists
5+
---
6+
7+
TODO: Update this page introduce the Data Scientists section of the docs. Or, delete it.

‎docs/desktop-engineers-root.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
id: desktop-engineers-root
3+
title: Root Page
4+
slug: /desktop-engineers
5+
---
6+
7+
TODO: Update this page introduce the Desktop Engineers section of the docs. Or, delete it.

‎docs/experiment-owners-root.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
id: experiment-owners-root
3+
title: Root Page
4+
slug: /experiment-owners
5+
---
6+
7+
TODO: Update this page introduce the Experiment Owners section of the docs. Or, delete it.

‎docs/fenix-engineers-root.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
id: fenix-engineers-root
3+
title: Root Page
4+
slug: /fenix-engineers
5+
---
6+
7+
TODO: Update this page introduce the Fenix Engineers section of the docs. Or, delete it.

‎docs/welcome.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
id: welcome
3+
title: Welcome
4+
slug: /
5+
---
6+
7+
Welcome to the [Experimenter](https://github.com/mozilla/experimenter) documentation hub! The goal of this website is to serve as a central location for documenting and linking to documentation of all things Experimenter, Nimbus, Jetstream, and related SDKs.
8+
9+
You will find documentation pages linked in the sidebar, and all external links are denoted with an external icon.
10+
11+
This website is built using [Docusaurus](https://v2.docusaurus.io/).
12+
13+
## Important links
14+
15+
In addition to the links in the sidebar here are some important links to have on hand:
16+
17+
| Link | | |
18+
| --------------- | ------------------------------------- | ---------------------------- |
19+
| Legacy Home | [Production][legacy_home_prod] | [Staging][legacy_home_stage] |
20+
| Nimbus Home | [Production][nimbus_home_prod] | [Staging][nimbus_home_stage] |
21+
| Remote Settings | [Production][rs_prod] | [Staging][rs_stage] |
22+
| Storybook | [Storybook Directory][storybook_prod] | |
23+
24+
[legacy_home_prod]: https://experimenter.services.mozilla.com/
25+
[legacy_home_stage]: https://stage.experimenter.nonprod.dataops.mozgcp.net/
26+
[nimbus_home_prod]: https://experimenter.services.mozilla.com/nimbus
27+
[nimbus_home_stage]: https://stage.experimenter.nonprod.dataops.mozgcp.net/nimbus
28+
[storybook_prod]: https://storage.googleapis.com/mozilla-storybooks-experimenter/index.html
29+
[rs_prod]: https://settings-writer.prod.mozaws.net/v1/admin/
30+
[rs_stage]: https://settings-writer.stage.mozaws.net/v1/admin/
31+
32+
## Contributing
33+
34+
This documentation is managed in the [mozilla/experimenter-docs](https://github.com/mozilla/experimenter-docs) repository. Content is written in Markdown files using [GitHub-flavored Markdown syntax](https://github.github.com/gfm/) and compiled into static pages. Refer to Docusaurus [Markdown features](https://v2.docusaurus.io/docs/markdown-features) for more technical information about these Markdown pages.
35+
36+
In order to protect the main deploy branch we are requiring all content changes (editing existing pages and creating new pages) to be reviewed and merged via Pull Request. **All changes merged into the `main` branch will automatically be deployed.**
37+
38+
### Creating new pages
39+
40+
[Click here](https://github.com/mozilla/experimenter-docs/new/main/docs) to start creating a new Markdown file in the repository. Once you've written your content you can can click "Commit Changes" to create a new branch and be presented with the option to open a Pull Request.
41+
42+
:::important
43+
44+
One caveat to adding new pages is that if you want them to show up in the sidebar they must be added to the [sidebars.js](https://github.com/mozilla/experimenter-docs/blob/main/sidebars.js) file. If you are adding a new file using the GitHub UI you must first make sure you have changed to the branch you just created with your new page commit. Then you can use the UI to add your new page to the sidebar and add that commit to the Pull Request.
45+
46+
:::
47+
48+
### Editing pages
49+
50+
You can edit any page in these docs by clicking the "**Edit this page**" link near the bottom. This will take you to the GitHub markdown file for the page, where you can make changes to the content. Once you've finished updating the content you can can click "Commit Changes" to create a new branch and be presented with the option to open a Pull Request.

‎sidebars.js‎

Lines changed: 89 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,91 @@
11
module.exports = {
2-
someSidebar: {
3-
Docusaurus: ['doc1', 'doc2', 'doc3'],
4-
Features: ['mdx'],
5-
},
2+
sidebar: [
3+
"welcome",
4+
{
5+
type: "category",
6+
label: "Process",
7+
items: [
8+
{
9+
type: "link",
10+
label: "Nimbus Onboarding",
11+
href: "https://mana.mozilla.org/wiki/display/FJT/Nimbus+Onboarding#NimbusOnboarding-Branches",
12+
},
13+
{
14+
type: "link",
15+
label: "How to Launch a Nimbus Experiment",
16+
href: "https://mana.mozilla.org/wiki/display/FJT/How+to+Launch+a+Nimbus+Experiment",
17+
},
18+
{
19+
type: "link",
20+
label: "Nimbus Data Transfer Object",
21+
href: "https://mana.mozilla.org/wiki/pages/viewpage.action?pageId=130920248"
22+
},
23+
{
24+
type: "link",
25+
label: "Experiment Telemetry",
26+
href: "https://mana.mozilla.org/wiki/display/FJT/Nimbus+Engineering#NimbusEngineering-ExperimentTelemetry"
27+
},
28+
{
29+
type: "link",
30+
label: "Lessons Learned",
31+
href: "https://mana.mozilla.org/wiki/display/FJT/Lessons+Learned+-+Experiment+Incidents+and+Close+Calls",
32+
},
33+
]
34+
},
35+
{
36+
type: 'category',
37+
label: 'Jetstream',
38+
items: [
39+
{
40+
type: "link",
41+
label: "GitHub Repo",
42+
href: "https://github.com/mozilla/jetstream"
43+
},
44+
{
45+
type: "link",
46+
label: "Documentation",
47+
href: "https://docs.telemetry.mozilla.org/datasets/jetstream.html"
48+
},
49+
],
50+
},
51+
{
52+
type: 'category',
53+
label: 'Experiment Owners',
54+
items: ["experiment-owners-root"],
55+
},
56+
{
57+
type: 'category',
58+
label: 'Fenix Engineers',
59+
items: [
60+
"fenix-engineers-root",
61+
{
62+
type: "link",
63+
label: "Android API (proposal)",
64+
href: "https://docs.google.com/document/d/1kchihPal0__A4VOAiPJarNuZXns5KhOHHfIeIzT6zfU/edit#",
65+
},
66+
],
67+
},
68+
{
69+
type: 'category',
70+
label: 'Desktop Engineers',
71+
items: [
72+
"desktop-engineers-root",
73+
{
74+
type: "link",
75+
label: "Front-End Migration Guide",
76+
href: "https://www.notion.so/Nimbus-Migration-Guide-for-Desktop-Front-End-Experiments-d36c21e505f84550aad1202897fc4ba3",
77+
},
78+
{
79+
type: "link",
80+
label: "SDK Docs (X-Man draft)",
81+
href: "https://docs.google.com/document/d/1ev75pG0nAM1lz53WuPQkWqykUlZMmZRbx8wzvvn5DhU/edit",
82+
},
83+
],
84+
},
85+
{
86+
type: 'category',
87+
label: 'Data Scientists',
88+
items: ["data-scientists-root"],
89+
}
90+
],
691
};

0 commit comments

Comments
 (0)