Skip to content

Commit

Permalink
feat(article): improve content grammar
Browse files Browse the repository at this point in the history
  • Loading branch information
@KennethTrecy
KennethTrecy committed Nov 5, 2023
1 parent 93a1b55 commit 8703535
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 19 deletions.
18 changes: 9 additions & 9 deletions src/routes/articles/installation_guide_for_fragmented_web_servers/+page.svelte
View file
Original file line number Diff line number Diff line change
Expand Up @@ -251,13 +251,13 @@
<StructuredSection itemprop="about" id={problem.id}>
<SecondaryHeading headingInfo={problem}/>
<SimpleText itemprop="description">
Some web developers may have used an <Keyword>all-in-one server</Keyword> during their first years in web development. One notable example of a all-in-one server is <Citation info={references[0]}>XAMPP</Citation>. The all-in-one servers may have a database server and HTTP server with an integrated interpreter (usually to execute server-side PHP scripts).
Some web developers may have used an <Keyword>all-in-one server</Keyword> during their first years in web development. One notable example of an all-in-one server is <Citation info={references[0]}>XAMPP</Citation>. The all-in-one servers may have a database server and HTTP server with an integrated interpreter (usually to execute server-side PHP scripts).
</SimpleText>
<SimpleText itemprop="description">
However, bundled servers are not always good for scalability or customizability purposes. Thus, the author created this <strong itemprop="mainEntity">guide for other developers to set up their "<Keyword>fragmented web servers</Keyword>".</strong>
</SimpleText>
<SimpleText>
If a server component of that bundled server has newer version, developers would need to wait for a new installer containing all of the updates. The developer would also need to download large amount of bytes to get installer which may only update one or more components.
If a server component of that bundled server has newer version, developers would need to wait for a new installer containing all of updates. The developer would also need to download large amount of bytes to get installer which may only update one or more components.
</SimpleText>
<SimpleText>
There are no problems on using a bundled server especially if the developers are looking for a quick and easy solution or if they are still at beginner level. Yet, the I.T. industry at this era is fast-paced. When the beginner developers are already done with their basic lessons, this guide would prove to be a useful for them to grow further.
Expand Down Expand Up @@ -304,7 +304,7 @@
Unzip Apache HTTP server to your chosen directory. Label the chosen directory as <var>APACHE_ROOT</var>.
</DescriptiveListItem>
<DescriptiveListItem>
Find the HTTP server configuration file on <em><var>APACHE_ROOT</var>/conf/httpd.conf</em> and open it.
Find the HTTP server configuration file on <em><var>APACHE_ROOT</var>/conf/httpd&period;conf</em> and open it.
</DescriptiveListItem>
<DescriptiveListItem>
Uncomment the following modules to enable them: <Citation info={references[2]}>access_compat</Citation>, <Citation info={references[3]}>rewrite</Citation>, and <Citation info={references[4]}>headers</Citation>. Reader can find the modules in the format like this one:<code>LoadModule access_compat_module modules/mod_access_compat.so</code>. Note that filenames may differ depending on the operating system being used.
Expand All @@ -314,7 +314,7 @@
</DescriptiveListItem>
</StructuredList>
<ExampleCodePart
filename="httpd.conf"
filename="httpd&period;conf"
rawCodeLines={sampleServerConfiguration}
beginLineIndex={beginLineIndexOfServerConfigurationPartA}
endLineIndex={endLineIndexOfServerConfigurationPartA}/>
Expand All @@ -335,7 +335,7 @@
Unzip PHP interpreter to your chosen directory. Label the chosen directory as <var>PHP_ROOT</var>.
</DescriptiveListItem>
<DescriptiveListItem>
Find the HTTP server configuration file on <em><var>APACHE_ROOT</var>/conf/httpd.conf</em> and open it.
Find the HTTP server configuration file on <em><var>APACHE_ROOT</var>/conf/httpd&period;conf</em> and open it.
</DescriptiveListItem>
<DescriptiveListItem>
Add <code>LoadModule php_module "PHP_ROOT/php8apache2_4.dll"</code> below the list of modules inside the HTTP server configuration file. This step may vary depending on the major version of the chosen PHP interpreter. Change the <em>PHP_ROOT</em> according to the real path of directory done in step 2.
Expand All @@ -354,7 +354,7 @@
</DescriptiveListItem>
</StructuredList>
<ExampleCodePart
filename="httpd.conf"
filename="httpd&period;conf"
rawCodeLines={sampleServerConfiguration}
beginLineIndex={beginLineIndexOfServerConfigurationPartB}
endLineIndex={endLineIndexOfServerConfigurationPartB}/>
Expand Down Expand Up @@ -408,15 +408,15 @@
There are many directives that can affect server behavior. It is best to research about them. See the reference for the module that provides the specific directive.
</SimpleText>
<ExampleCodePart
filename="httpd.conf"
filename="httpd&period;conf"
rawCodeLines={sampleServerConfiguration}
beginLineIndex={beginLineIndexOfServerConfigurationPartC}
endLineIndex={endLineIndexOfServerConfigurationPartC}/>
</StructuredSection>
<StructuredSection id={spaceForImprovements.id}>
<SecondaryHeading headingInfo={spaceForImprovements}/>
<SimpleText itemprop="description">
There are more advanced configurations left as an exercise for the reader. The author recommends the readers to read the documentation for each tool the they use to further their expertise. This is the best bridge available between the source code that explains the exact process and video tutorials that usually provide an overview for beginners.
There are more advanced configurations left as an exercise for the reader. The author recommends the readers to read the documentation for each tool they use to further their expertise. This is the best bridge available between the source code that explains the exact process and video tutorials that usually provide an overview for beginners.
</SimpleText>
<SimpleText>
Note that the instructions available in this article is a result of several years of experience that the author gained in setting up the servers. It is a difficult path especially for someone is learning these concepts without any supervision or mentorship.
Expand All @@ -427,7 +427,7 @@
address="/about_myself"
relationship={[ ...internalTypes, ...authorTypes ]}
itemprop="mainEntityOfPage">author</BaseLink>
and send the details that needs to be corrected, updated, or improved upon.
and send the details that need to be corrected, updated, or improved upon.
</SimpleText>
</StructuredSection>
</BodyGroup>
Expand Down
18 changes: 8 additions & 10 deletions src/routes/articles/key_steps_to_add_gramma_for_improved_ci/+page.svelte
View file
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@
<StructuredSection id={localSetup.id}>
<SecondaryHeading headingInfo={localSetup}/>
<SimpleText>
The steps below assumes that there is a website, real or hypothetical, that would be check for its grammar.
The steps below assumes that there is a website, real or hypothetical, that would be checked for its grammar.
</SimpleText>
<StructuredList order="ascending">
<meta itemprop="numberOfItems" content={`${setupSteps.length}`}>
Expand Down Expand Up @@ -199,26 +199,24 @@
<StructuredSection id={setupSteps[1].id}>
<TertiaryHeading headingInfo={setupSteps[1]}/>
<SimpleText>
The second step is to setup the E2E testing framework to be used. For this guide, <Citation info={references[4]}>Playwright package</Citation> would be used. The readers may choose their preferred framework to scrape the contents of the website as long as they could request through the package from the <Bookmark
The second step is to set up the E2E testing framework to be used. For this guide, <Citation info={references[4]}>Playwright package</Citation> would be used. The readers may choose their preferred framework to scrape the contents of the website as long as they could request through the package from the <Bookmark
itemprop="citation"
fragment={`#${setupSteps[0].id}`}>
first step
</Bookmark>.
fragment={`#${setupSteps[0].id}`}>first step</Bookmark>.
</SimpleText>
<ExampleCommand commandInfos={installOptionalPackageCommandInfo}/>
<SimpleText>
If the reader chose <Citation info={references[4]}>Playwright package</Citation>, use the following configuration below and save it as <em>playwright.config.ts</em> in the project root. Note that <code>npm run preview</code> would run HTTP server binded on a certain port. In the configuration below, it requires the server should be found on port 4173. The readers may customize the command and port according to their setup.
If the reader chose <Citation info={references[4]}>Playwright package</Citation>, use the following configuration below and save it as <em>playwright.config.ts</em> in the project root. Note that <code>npm run preview</code> would run HTTP server bound on a certain port. In the configuration below, it requires the server should be found on port 4173. The readers may customize the command and port according to their setup.
</SimpleText>
<ExampleCode codeInfo={$loadedFileInfos[0]}/>
</StructuredSection>
<StructuredSection id={workflowConfiguration.id}>
<SecondaryHeading headingInfo={workflowConfiguration}/>
<SimpleText>
Copy the code below and paste it a file under <em>.github/workflows</em> from the project root. The readers may name it whatever they like.
Copy the code below and paste it a file under <em>&period;github/workflows</em> from the project root. The readers may name it whatever they like.
</SimpleText>
<ExampleCode codeInfo={$loadedFileInfos[1]} endLineIndex={38}/>
<SimpleText>
On lines 30 - 31, it double checks if the <Citation info={references[3]}>LanguageTool server</Citation> is not yet running. After that, the lines 34 - 35, explicitly starts it. The line 36 - 37 just confirms if the server is running. The grammar-checking activity starts at line 38.
On lines 30 - 31, it double-checks if the <Citation info={references[3]}>LanguageTool server</Citation> is not yet running. After that, the lines 34 - 35, explicitly starts it. The line 36 - 37 just confirms if the server is running. The grammar-checking activity starts at line 38.
</SimpleText>
</StructuredSection>
<StructuredSection id={execution.id}>
Expand Down Expand Up @@ -250,7 +248,7 @@
</StructuredListItem>
</StructuredList>
<SimpleText>
After creating a test code, push the changes to a remote repository. The reader should check the "Actions" tab of the remote repository to see if the grammar checking tests works properly. If not, the mismatches would be shown by the chosen testing framework.
After creating a test code, push the changes to a remote repository. The reader should check the "Actions" tab of the remote repository to see if the grammar checking tests work properly. If not, the mismatches would be shown by the chosen testing framework.
</SimpleText>
<SimpleText>
Below is a snapshot of previous results of successful grammar check using the <Citation info={references[4]}>Playwright package</Citation>. Note that the presentation of results may vary per framework used for testing.
Expand All @@ -270,7 +268,7 @@
Good grammar is important both in formal and informal contexts, as it helps convey ideas correctly and is recommended by search engines. By utilizing continuous integration, grammatical errors can be caught early in the development before publishing document, article, or any group of texts.
</SimpleText>
<SimpleText>
The testing framework to be used is wholly dependent on the current progress in the system development, preferences, and other factors. It recommended to have unanimous decision for ease and fast progress of development.
The testing framework to be used is wholly dependent on the current progress in the system development, preferences, and other factors. It recommended having unanimous decision for ease and fast progress of development.
</SimpleText>
<SimpleText>
Regardless of the framework, this article has presented a pattern to conduct grammar checks. The reader may even request directly to the API of <Citation info={references[3]}>LanguageTool server</Citation> if they know how to translate the code according to their chosen technologies and programming language.
Expand Down

0 comments on commit 8703535

Please sign in to comment.