updated a few things #18

finickydesert · 2023-09-03T12:40:27Z

fixed the grammar a bit.

I corrected the grammar a bit

Corrected the grammar on this page, I hope.

I corrected a few things on this page.

Updated the grammar

garrettw

Overall a lot of improvements here, but it's definitely not ready to be merged.

garrettw · 2023-09-15T02:26:54Z

docs/admin_guide.md

@@ -1,22 +1,22 @@
 # Admin Bare Metal/VM Guide

 Below is a step-by-step guide of the process for creating your own /kbin instance from the moment a new VPS/VM is created or directly on bare-metal. 
-This is a preliminary outline that will help you launch an instance for your own needs.
+This is a preliminary outline that will help you launch an instance for your needs.


"own" is not a problem here

garrettw · 2023-09-15T02:28:17Z

docs/admin_guide.md


 > **Note**
 > /kbin is still in the early stages of development.

 If you would like to support the project, you can register using the following [affiliate link](https://hetzner.cloud/?ref=8tSPCw0qqIwl).

-This guide is aimed for Debian / Ubuntu distribution servers, but it could run on any modern Linux distro. This guide will however uses the `apt` commands.
+This guide is aimed for Debian / Ubuntu distribution servers, but it could run on any modern Linux distro. This guide will, however, will use the `apt` commands.


This is still bad; you repeated "will". Just make it "will, however, use"

Hey, you can suggest changes on GitHub by specifying the triple-tick language to be "suggestion" and filling in your preferred version of the line like this!

Suggested change

This guide is aimed for Debian / Ubuntu distribution servers, but it could run on any modern Linux distro. This guide will, however, will use the `apt` commands.

This guide is aimed for Debian / Ubuntu distribution servers, but it could run on any modern Linux distro. This guide will, however, use the `apt` commands.

This way, they can easily implement your requests and you'll also get credited as the author of the commit.

garrettw · 2023-09-15T02:30:03Z

docs/admin_guide.md

@@ -243,15 +243,15 @@ sudo nano /etc/redis/redis.conf
 # Change no to systemd, considering Ubuntu is using systemd
 ```

-Save and exit (ctrl+x) the file.
+Save and exit (CTRL+x) the file.


If you consider "ctrl" to be wrong, then so is "CTRL". It's not an acronym, it's the word "Control", so use what most keyboards use: "Ctrl"

garrettw · 2023-09-15T02:34:15Z

docs/admin_guide.md

@@ -264,7 +264,7 @@ REDIS_DNS=redis://${REDIS_PASSWORD}@${REDIS_HOST}

 ### PostgreSQL (Database)

-Create new `kbin` database user, using the password, `{!SECRET!!KEY!-32_2-!}`, you generated earlier:
+Create a new `kbin` database user, using the password, `{!SECRET!!KEY!-32_2-!}`, you generated earlier:


This fix is correct, but the sentence is still awkward and needs more work.
I would suggest something like this:
Create a new kbin database user, using the password you generated earlier ({!SECRET!!KEY!-32_2-!}):

garrettw · 2023-09-15T02:35:43Z

docs/admin_guide.md

@@ -771,17 +771,17 @@ php bin/console kbin:user:admin <username>
 php bin/console kbin:ap:keys:update
 ```

-Next, log in and create a magazine named "random" to which unclassified content from the fediverse will flow.
+Next, log in and create a magazine named “random” to which unclassified content from the Fediverse will flow.


I'm not sure that adding smart quotes is useful or necessary.

garrettw · 2023-09-15T02:43:10Z

docs/oauth2_guide.md

@@ -30,7 +30,7 @@
 * `post:edit`
 * `post_comment:create`
 * `post_comment:edit`
-3. `delete` - Provides all of the following nested scopes, for deleting the current user's content
+3. `delete` - Provides all the following nested scopes, for deleting the current user's content


Same here -- "of" does belong

garrettw · 2023-09-15T02:43:35Z

docs/oauth2_guide.md

@@ -153,7 +153,7 @@
 * `moderate:magazine:reports:read`
 * Allows the client to read reports about content from magazines the user moderates
 * `moderate:magazine:reports:action`
- * Allows the client to take action on reports, either accepting or rejecting them
+ * Allows the client to act on reports, either accepting or rejecting them


I don't think either version here is better than the other

garrettw · 2023-09-15T02:46:08Z

docs/user_guide.md

@@ -8,42 +8,42 @@ The initiative aims to promote a free and open internet.
 ## Introduction

 The platform is divided into thematic categories called magazines. By default, any user can create their own magazine
-and automatically become its owner. Then they receive a number of administrative tools that will help them personalize
+and automatically become its owner. Then they receive many administrative tools that will help them personalize


This is not necessarily the same meaning. "Many" implies that the number of tools is large, while "a number of" generally carries the connotation of "maybe many, but at least several"

garrettw · 2023-09-15T02:48:23Z

docs/user_guide.md

 company platform or a general instance with thousands of active users.

 ## User guide

 ### Customization

-Everyone has the ability to customize the appearance to suit your preferences. In the sidebar, you'll find an options
+Everyone can customize the appearance to suit their preferences. In the sidebar, you'll find an option


"options" is more correct here, as the button's purpose is to reveal "a variety of settings". If the button used text rather than just an icon, it would more likely say "Options" rather than "Option".

garrettw · 2023-09-15T02:48:47Z

docs/user_guide.md


 So don't be afraid to experiment with the various options available in the sidebar. You might be surprised at just how
-much you can change the appearance of the platform to suit your preferences.
+much, you can change the appearance of the platform to suit your preferences.


This is 100% incorrect.

finickydesert added 4 commits September 3, 2023 12:34

Update admin_guide.md

e37137b

I corrected the grammar a bit

Update docker_deployment_guide.md

8350890

Corrected the grammar on this page, I hope.

Update oauth2_guide.md

8835b5d

I corrected a few things on this page.

Update user_guide.md

671d591

Updated the grammar

garrettw suggested changes Sep 15, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

updated a few things #18

updated a few things #18

finickydesert commented Sep 3, 2023

garrettw left a comment

garrettw Sep 15, 2023

garrettw Sep 15, 2023

aaronliu0130 Nov 11, 2023

garrettw Sep 15, 2023

garrettw Sep 15, 2023

garrettw Sep 15, 2023

garrettw Sep 15, 2023

garrettw Sep 15, 2023

garrettw Sep 15, 2023

garrettw Sep 15, 2023

garrettw Sep 15, 2023

	This guide is aimed for Debian / Ubuntu distribution servers, but it could run on any modern Linux distro. This guide will, however, will use the `apt` commands.
	This guide is aimed for Debian / Ubuntu distribution servers, but it could run on any modern Linux distro. This guide will, however, use the `apt` commands.

updated a few things #18

Are you sure you want to change the base?

updated a few things #18

Conversation

finickydesert commented Sep 3, 2023

garrettw left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment