Skip to content

Commit 803c7f9

Browse files
authored
docs: Small website and documentation improvements (vectordotdev#1215)
* Small website and documentation improvements Signed-off-by: Ben Johnson <[email protected]> * Responsive fixups Signed-off-by: Ben Johnson <[email protected]>
1 parent 458f6cc commit 803c7f9

File tree

28 files changed

+880
-307
lines changed

28 files changed

+880
-307
lines changed

.gitattributes

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
distribution/* linguist-detectable=false
2-
docs/* linguist-documentation
32
lib/* linguist-vendored
43
scripts/* linguist-detectable=false
4+
website/* linguist-detectable=false
55
Makefile linguist-detectable=false

.meta/installation.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ operating_systems = [
1111
{name = "CentOS", id = "centos"},
1212
{name = "Debian", id = "debian"},
1313
{name = "MacOS", id = "macos"},
14+
{name = "Raspberry Pi", id = "raspberry-pi"},
1415
{name = "RHEL", id = "rhel"},
1516
{name = "Ubuntu", id = "ubuntu"}
1617
]

website/README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,4 @@ This command generates static content into the `build` directory and can be serv
2626

2727
### Deployment
2828

29-
```
30-
$ GIT_USER=<Your GitHub username> USE_SSH=1 yarn deploy
31-
```
32-
33-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
29+
Automatically setup through Netlify. Commits to master will update the production site and each branch will get a preview site as part of the Github checks.

website/docs/about/guarantees.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ import Jump from '@site/src/components/Jump';
5252
</div>
5353
<div class="section">
5454

55-
### <i className="feather icon-shield-off"></i> Best-Effort
55+
### Best-Effort
5656

5757
A `best-effort` delivery guarantee means that Vector will make a best effort to
5858
deliver each event, but cannot guarantee delivery. While rare, this means it is

website/docs/setup/installation/operating-systems.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import Jump from '@site/src/components/Jump';
1010
<Jump to="/docs/setup/installation/operating-systems/centos">Centos</Jump>
1111
<Jump to="/docs/setup/installation/operating-systems/debian">Debian</Jump>
1212
<Jump to="/docs/setup/installation/operating-systems/macos">Macos</Jump>
13+
<Jump to="/docs/setup/installation/operating-systems/raspberry-pi">Raspberry pi</Jump>
1314
<Jump to="/docs/setup/installation/operating-systems/rhel">Rhel</Jump>
1415
<Jump to="/docs/setup/installation/operating-systems/ubuntu">Ubuntu</Jump>
1516

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Install Vector On Raspberry Pi
3+
sidebar_label: Raspberry Pi
4+
description: Install Vector On Raspberry Pi
5+
---
6+
7+
Vector can be installed on Raspberry Pi trough Vector's prebuilt archives.
8+
Depending on your process you'll want to select the appropriate archive:
9+
10+
* ARMv8 (64-bit): `aarch64-unknown-linux-musl`
11+
* ARMv7 (32-bit): `armv7-unknown-linux-musleabihf`
12+
13+
And the follow the standard archive installation guide:
14+
15+
import Jump from '@site/src/components/Jump';
16+
17+
<Jump to="/docs/setup/installation/manual/from-archives">Install From an Archive</Jump>
18+
19+
20+

website/docusaurus.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ module.exports = {
2323
{to: 'download', label: 'Download', position: 'right'},
2424
{
2525
href: 'https://github.com/timberio/vector',
26-
label: "Github",
26+
label: "GitHub",
2727
position: 'right',
2828
},
2929
],

website/metadata.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@ module.exports = {
2323
"name": "MacOS",
2424
"id": "macos"
2525
},
26+
{
27+
"name": "Raspberry Pi",
28+
"id": "raspberry-pi"
29+
},
2630
{
2731
"name": "RHEL",
2832
"id": "rhel"
@@ -70,7 +74,7 @@ module.exports = {
7074
"version": "0.5.0"
7175
},
7276
"posts": [
73-
"#<Post:0x00007fd533f407a8>"
77+
"#<Post:0x00007fb83138f608>"
7478
],
7579
"sources": {
7680
"udp": {

website/sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ module.exports = {
5555
"setup/installation/operating-systems/centos",
5656
"setup/installation/operating-systems/debian",
5757
"setup/installation/operating-systems/macos",
58+
"setup/installation/operating-systems/raspberry-pi",
5859
"setup/installation/operating-systems/rhel",
5960
"setup/installation/operating-systems/ubuntu",
6061
],

website/src/components/Diagram/index.js

Lines changed: 36 additions & 33 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)