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

🔗Improve Docs #28

Draft
wants to merge 10 commits into
base: main
Choose a base branch
from
3 changes: 2 additions & 1 deletion docs/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title = "index"
insert_anchor_links = "right"
+++

## Welcome to the Gluon docs
## Welcome to the Gluon documentation!

If you are new here, you should read the [Getting Started](./getting-started/overview/) guide.
If you use Windows, you should read the [Windows instructions](./guides/windows.md).
2 changes: 1 addition & 1 deletion docs/content/getting-started/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ If you are having problems with following these instructions, or with gluon in g

### System requirements

- **OS**: Linux and MacOS (If you are using windows, take a look at the [Windows Guide](../windows/))
- **OS**: Linux and MacOS (If you are using windows, take a look at the [Windows Guide](../guides/windows/))
- **Gluon dependencies**: NodeJS and npm
- **Browser dependencies**: Will be handled by bootstrapping

Expand Down
24 changes: 12 additions & 12 deletions docs/content/guides/removingPocket.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,22 @@ weight = 5
The goal of this guide is to disable pocket and remove its icon from the toolbar. The first changes we will need to make is to the firefox.js file located in `engine/browser/app/profile/firefox.js`. Scroll to the lines that include the following settings (around line 1980 in firefox 94):

```js
pref('extensions.pocket.api', 'api.getpocket.com')
pref('extensions.pocket.enabled', true)
pref('extensions.pocket.oAuthConsumerKey', '40249-e88c401e1b1f2242d9e441c4')
pref('extensions.pocket.site', 'getpocket.com')
pref('extensions.pocket.onSaveRecs', true)
pref('extensions.pocket.onSaveRecs.locales', 'en-US,en-GB,en-CA')
pref('extensions.pocket.api', 'api.getpocket.com');
pref('extensions.pocket.enabled', true);
pref('extensions.pocket.oAuthConsumerKey', '40249-e88c401e1b1f2242d9e441c4');
pref('extensions.pocket.site', 'getpocket.com');
pref('extensions.pocket.onSaveRecs', true);
pref('extensions.pocket.onSaveRecs.locales', 'en-US,en-GB,en-CA');
```

Delete these lines and replace them with the following:

```js
// Taken from BetterFox user.js
user_pref('extensions.pocket.enabled', false)
user_pref('extensions.pocket.api', ' ')
user_pref('extensions.pocket.oAuthConsumerKey', ' ')
user_pref('extensions.pocket.site', ' ')
user_pref('extensions.pocket.enabled', false);
user_pref('extensions.pocket.api', ' ');
user_pref('extensions.pocket.oAuthConsumerKey', ' ');
user_pref('extensions.pocket.site', ' ');
```

Next, you will need to remove pocket from the new tab page. You can do this by simply adding the following line to the bottom of `firefox.js`:
Expand All @@ -36,7 +36,7 @@ Next, you will need to remove pocket from the new tab page. You can do this by s
user_pref(
'browser.newtabpage.activity-stream.section.highlights.includePocket',
false
)
);
```

Now you simply need to export the changes made to `firefox.js`:
Expand All @@ -47,7 +47,7 @@ gluon export-file browser/app/profile/firefox.js

## Removing pocket icon from toolbar

Whilst the steps above will have disabled pocket. The pocket icon will still be visible in the toolbar. Instead you must remove it from the CustomizableUI layout. Open `engine/browser/components/customizableui/CustomizableUI.jsm` and find the array that looks like this (around line 240):
Whilst the steps above will have disabled pocket, the pocket icon will still be visible in the toolbar. You must still remove it from the CustomizableUI layout. Open `engine/browser/components/customizableui/CustomizableUI.jsm` and find the array that looks like this (around line 240):

```js
let navbarPlacements = [
Expand Down
9 changes: 4 additions & 5 deletions docs/content/guides/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ weight = 0

# Preparing Windows

Building on windows is significantly more complex than building on macos or linux. This guide will walk you through preparing your Windows machine for building a Firefox fork. Before building, you should be aware that [only Windows 10 or 11 are officially supported](https://firefox-source-docs.mozilla.org/build/buildsystem/supported-configurations.html#build-hosts), but you might be able to get other versions to work.
Building on Windows is significantly more complex than building on MacOS or Linux. This guide will walk you through preparing your Windows machine for building a Firefox fork. Before building, you should be aware that [only Windows 10 or 11 are officially supported](https://firefox-source-docs.mozilla.org/build/buildsystem/supported-configurations.html#build-hosts), but you might be able to get other versions to work.

## Installing Dependencies

Expand All @@ -26,24 +26,23 @@ You will need to install [MozillaBuild](https://ftp.mozilla.org/pub/mozilla/libr
- Configuring the line ending conversions must be: Checkout as-is, commit as-is
- Enable experimental built-in file system monitor

Install [NodeJS](https://nodejs.org/en/download/current/) on your system. This should also install chocolatey. If it does not, [install it manually](https://docs.chocolatey.org/en-us/choco/setup). To install the final two dependencies, run:
Install [NodeJS](https://nodejs.org/en/download/current/) on your system. This should also install Chocolatey. If it does not, [install it manually](https://docs.chocolatey.org/en-us/choco/setup). To install the final two dependencies, run:

```sh
npm install --global yarn
choco install make
```

You should be good to return back to the main [Getting Started docs](/getting-started/overview)

## Additional packages required for releasing

If you are creating binaries to target windows, you will need nsis (which mach calls `makensisu` for some reason, even though the binary is `makensis`):
If you are creating binaries to target Windows, you will need NSIS (which mach calls `makensisu` for some reason, even though the binary is `makensis`):

```powershell
choco install nsis
```

Note that you will also have to provide a path to nsis on your system. For mine it is:
Note that you will also have to provide a path to NSIS on your system. For mine it is:

```sh
export MAKENSISU="C:\\Program Files (x86)\\NSIS\\Bin\\makensis.exe"
Expand Down
8 changes: 4 additions & 4 deletions docs/content/reference/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This is the name of the product that is to be built.

## vendor

The name of the company that is building the browser
The name of the company that is building the browser.

```json
{
Expand All @@ -29,7 +29,7 @@ The name of the company that is building the browser

## appId

A reverse DNS identifier for the browser
A reverse DNS identifier for the browser.

```json
{
Expand All @@ -49,7 +49,7 @@ The name of the output binary.

## updateHostname

The host of the update server for updating. This is configured as part of the build command
The host of the update server for updating. This is configured as part of the build command.

```json
{
Expand Down Expand Up @@ -149,7 +149,7 @@ These are flags that change how parts of Gluon operate.

### windowsUseSymbolicLinks

When set to `true`, symbolic links will be enabled on Windows. From internal testing, this appears to fail on a majority of computers
When set to `true`, symbolic links will be enabled on Windows. From internal testing, this appears to fail on a majority of computers.

## addons

Expand Down
Loading