github-personal/firezone
1
0
Fork 0
mirror of https://github.com/outbackdingo/firezone.git synced 2026-01-27 18:18:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs fixes (#911)

Browse Source 
* update architecture diagram

* fix edit this page link

* fix keywords not showing

* remove trailing slash
This commit is contained in:
Jason G
2022-08-10 17:51:20 -04:00
committed by GitHub
parent 5e60d2b442
commit 36c605c36f
3 changed files with 5 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -28,13 +28,13 @@
* [Deploy on your own infrastructure](https://docs.firezone.dev/deploy) to keep control of your network traffic.
* Built on [WireGuard®](https://www.wireguard.com/) to be stable, performant, and lightweight.
![Firezone Architecture](https://user-images.githubusercontent.com/52545545/173246039-a1b37ef2-d885-4535-bca7-f5cd57da21a2.png)
![Firezone Architecture](https://user-images.githubusercontent.com/52545545/183804397-ae81ca4e-6972-41f9-80d4-b431a077119d.png)
## Get Started
Follow our [deploy guide](https://docs.firezone.dev/deploy) to install your self-hosted instance of Firezone.
Or, if you're on a [supported platform](https://docs.firezone.dev/deploy/supported-platforms/), try our one-line install script:
Or, if you're on a [supported platform](https://docs.firezone.dev/deploy/supported-platforms), try our one-line install script:
```bash
sudo -E bash -c "$(curl -fsSL https://github.com/firezone/firezone/raw/master/scripts/install.sh)"
@@ -77,7 +77,6 @@ help:
* [Community Slack](https://www.firezone.dev/slack): join discussions, meet other users, and meet the contributors
* [Email Us](mailto:team@firezone.dev): we're always happy to chat
## Package Repository
[![Hosted By: Cloudsmith](https://img.shields.io/badge/OSS%20hosting%20by-cloudsmith-blue?logo=cloudsmith&style=for-the-badge)](https://cloudsmith.com)
@@ -87,7 +86,6 @@ Cloudsmith is the only fully hosted, cloud-native, universal package management
enables your organization to create, store and share packages in any format, to any place, with total
confidence.
## Developing and Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md).

2
docs/docs/README.md
View File

@@ -7,7 +7,7 @@ sidebar_position: 1
egress firewall for Linux. Use it to **quickly and easily** secure access to
your private network and internal applications from a simple Web UI.
![Architecture](https://user-images.githubusercontent.com/52545545/173246039-a1b37ef2-d885-4535-bca7-f5cd57da21a2.png)
![Architecture](https://user-images.githubusercontent.com/52545545/183804397-ae81ca4e-6972-41f9-80d4-b431a077119d.png)
These docs explain how to deploy, configure, and use Firezone.

6
docs/docusaurus.config.js
View File

@@ -51,7 +51,7 @@ const config = {
docs: {
routeBasePath: "/",
sidebarPath: require.resolve("./sidebars.js"),
editUrl: "https://github.com/firezone/firezone",
editUrl: "https://github.com/firezone/firezone/tree/master",
},
theme: {
customCss: require.resolve("./src/css/custom.css"),
@@ -162,9 +162,7 @@ const config = {
//... other Algolia params
},
themeConfig: {
metadata: [{name: 'keywords', content: 'wireguard, vpn, firewall, remote, network, documentation'}],
},
metadata: [{name: 'keywords', content: 'wireguard, vpn, firewall, remote access, network, documentation'}],
}),
};