From d9806a4020c374cc568c18eb11275f647c27667d Mon Sep 17 00:00:00 2001 From: Lynette Miles Date: Fri, 8 Nov 2024 09:56:57 -0800 Subject: [PATCH 1/2] install: source: update for style and consistency Signed-off-by: Lynette Miles --- installation/sources/download-source-code.md | 24 ++++++++++++------- vale-styles/FluentBit/Spelling-exceptions.txt | 1 + 2 files changed, 17 insertions(+), 8 deletions(-) diff --git a/installation/sources/download-source-code.md b/installation/sources/download-source-code.md index b82d74098..1d36f41e9 100644 --- a/installation/sources/download-source-code.md +++ b/installation/sources/download-source-code.md @@ -1,23 +1,31 @@ -# Download Source Code +# Download source code + +You can download the most recent stable, or development source code. ## Stable -For production systems, we strongly suggest that you always get the latest stable release of the source code in either zip or tarball format from Github using the following link pattern: +For production systems, it's strongly suggested that you get the latest stable release +of the source code in either zip or tarball format from Github using the following +link pattern: +```text https://github.com/fluent/fluent-bit/archive/refs/tags/v<release version>.tar.gz https://github.com/fluent/fluent-bit/archive/refs/tags/v<release version>.zip +``` -For example for version 1.8.12 the link is the following: [https://github.com/fluent/fluent-bit/archive/refs/tags/v1.8.12.tar.gz](https://github.com/fluent/fluent-bit/archive/refs/tags/v1.8.12.tar.gz) +For example, for version 1.8.12 the link is: [https://github.com/fluent/fluent-bit/archive/refs/tags/v1.8.12.tar.gz](https://github.com/fluent/fluent-bit/archive/refs/tags/v1.8.12.tar.gz) ## Development -For anyone who aims to contribute to the project by testing or extending the code base, you can get the development version from our GIT repository: +If you want to contribute to Fluent Bit, you should use the most recent code. You can +get the development version from the Git repository: ```bash -$ git clone https://github.com/fluent/fluent-bit +git clone https://github.com/fluent/fluent-bit ``` -Note that our _master_ branch is where the development of Fluent Bit happens. -Since it's a development version, expect issues when compiling or at run time. +The `master` branch is where the development of Fluent Bit happens. +Development version users should expect issues when compiling or at run time. -We encourage everybody to help us testing every development version, at the end this is what will become stable. +Fluent Bit users are encouraged to help test every development version to ensure a +stable release. diff --git a/vale-styles/FluentBit/Spelling-exceptions.txt b/vale-styles/FluentBit/Spelling-exceptions.txt index c2e85e2e7..2cbee98eb 100644 --- a/vale-styles/FluentBit/Spelling-exceptions.txt +++ b/vale-styles/FluentBit/Spelling-exceptions.txt @@ -58,6 +58,7 @@ Fargate Firehose FluentBit Fluentd +github glibc Golang golib From ea7a72f762a5c6c41af2c1f8d212c6450572b3ab Mon Sep 17 00:00:00 2001 From: esmerel <6818907+esmerel@users.noreply.github.com> Date: Fri, 8 Nov 2024 11:54:24 -0800 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Craig Norris <112565517+cnorris-cs@users.noreply.github.com> Signed-off-by: esmerel <6818907+esmerel@users.noreply.github.com> --- installation/sources/download-source-code.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/installation/sources/download-source-code.md b/installation/sources/download-source-code.md index 1d36f41e9..729f3144c 100644 --- a/installation/sources/download-source-code.md +++ b/installation/sources/download-source-code.md @@ -1,12 +1,12 @@ # Download source code -You can download the most recent stable, or development source code. +You can download the most recent stable or development source code. ## Stable For production systems, it's strongly suggested that you get the latest stable release -of the source code in either zip or tarball format from Github using the following -link pattern: +of the source code in either zip file or tarball file format from GitHub using the +following link pattern: ```text https://github.com/fluent/fluent-bit/archive/refs/tags/v<release version>.tar.gz @@ -24,7 +24,7 @@ get the development version from the Git repository: git clone https://github.com/fluent/fluent-bit ``` -The `master` branch is where the development of Fluent Bit happens. +The `master` branch is where the development of Fluent Bit happens. Development version users should expect issues when compiling or at run time. Fluent Bit users are encouraged to help test every development version to ensure a