-
Notifications
You must be signed in to change notification settings - Fork 45
Initial sidebar links, further setup tweaks #2
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
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
0ca869e
Remove initial doc pages
jodyheavener d16103c
Config tweaks, replace home page with root doc, updated favicon
jodyheavener cfe32d5
Style tweaks, add external icons
jodyheavener e4c7580
Add some initial documentation pages and sidebar links
jodyheavener c000056
Add Algolia search
jodyheavener File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| --- | ||
| id: data-scientists-root | ||
| title: Root Page | ||
| slug: /data-scientists | ||
| --- | ||
|
|
||
| TODO: Update this page introduce the Data Scientists section of the docs. Or, delete it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| --- | ||
| id: desktop-engineers-root | ||
| title: Root Page | ||
| slug: /desktop-engineers | ||
| --- | ||
|
|
||
| TODO: Update this page introduce the Desktop Engineers section of the docs. Or, delete it. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| --- | ||
| id: experiment-owners-root | ||
| title: Root Page | ||
| slug: /experiment-owners | ||
| --- | ||
|
|
||
| TODO: Update this page introduce the Experiment Owners section of the docs. Or, delete it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| --- | ||
| id: fenix-engineers-root | ||
| title: Root Page | ||
| slug: /fenix-engineers | ||
| --- | ||
|
|
||
| TODO: Update this page introduce the Fenix Engineers section of the docs. Or, delete it. |
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| --- | ||
| id: welcome | ||
| title: Welcome | ||
| slug: / | ||
| --- | ||
|
|
||
| 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. | ||
|
|
||
| You will find documentation pages linked in the sidebar, and all external links are denoted with an external icon. | ||
|
|
||
| This website is built using [Docusaurus](https://v2.docusaurus.io/). | ||
|
|
||
| ## Important links | ||
|
|
||
| In addition to the links in the sidebar here are some important links to have on hand: | ||
|
|
||
| | Link | | | | ||
| | --------------- | ------------------------------------- | ---------------------------- | | ||
| | Legacy Home | [Production][legacy_home_prod] | [Staging][legacy_home_stage] | | ||
| | Nimbus Home | [Production][nimbus_home_prod] | [Staging][nimbus_home_stage] | | ||
| | Remote Settings | [Production][rs_prod] | [Staging][rs_stage] | | ||
| | Storybook | [Storybook Directory][storybook_prod] | | | ||
|
|
||
| [legacy_home_prod]: https://experimenter.services.mozilla.com/ | ||
| [legacy_home_stage]: https://stage.experimenter.nonprod.dataops.mozgcp.net/ | ||
| [nimbus_home_prod]: https://experimenter.services.mozilla.com/nimbus | ||
| [nimbus_home_stage]: https://stage.experimenter.nonprod.dataops.mozgcp.net/nimbus | ||
| [storybook_prod]: https://storage.googleapis.com/mozilla-storybooks-experimenter/index.html | ||
| [rs_prod]: https://settings-writer.prod.mozaws.net/v1/admin/ | ||
| [rs_stage]: https://settings-writer.stage.mozaws.net/v1/admin/ | ||
|
|
||
| ## Contributing | ||
|
|
||
| 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. | ||
|
|
||
| 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.** | ||
|
|
||
| ### Creating new pages | ||
|
|
||
| [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. | ||
|
|
||
| :::important | ||
|
|
||
| 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. | ||
|
|
||
| ::: | ||
|
|
||
| ### Editing pages | ||
|
|
||
| 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. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wellllll... I could have sworn Docusaurus did this automagically.☹️ I'll figure this out when working on the maintenance workflow docs (you've already written like more than half of it so thanks, ha).