Skip to content

Commit 8c9888b

Browse files
authored
Merge pull request #14 from DanRoscigno/docs-as-code-update
edits
2 parents 5220c44 + 286460e commit 8c9888b

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

Diff for: content/documentation/modules/ROOT/pages/docs-as-code.adoc

+6-6
Original file line numberDiff line numberDiff line change
@@ -78,15 +78,15 @@ data used in the tests don't make their way into the documentation.
7878
=== The fix
7979

8080
* Treat the docs as code.
81-
* As end to end docs (tutorials, quick starts, how to guides) are designed they
81+
* As end to end docs (tutorials, quick starts, how-to guides) are designed, they
8282
should be written as test plans.
8383
* Automate the test plan.
8484
* Write the doc, but instead of copy/pasting the code snippets (SQL in my case)
8585
into the docs, import the snippets directly from the automated test.
8686
* Run the test suite on a regular basis.
87-
* As tests fail get the code fixed if the failure indicates a bug, or update the
87+
* As tests fail, get the code fixed if the failure indicates a bug, or update the
8888
test to include the new behavior of the system. The update to the test should cause
89-
an update to the documentation as the doc system is pulling the code snippets
89+
an update to the documentation, as the doc system is pulling the code snippets
9090
from the tests.
9191

9292
=== Example
@@ -111,7 +111,7 @@ AS SELECT * FROM FILES (
111111
----
112112

113113
Yesterday I would have copied the above out of the SQL client I used to run
114-
the query and pasted it into a Markdown file. But today I would instead use
114+
the query and pasted it into a Markdown file. But today, I would instead use
115115
this syntax to grab the above from the test specification like so:
116116

117117
[,markdown]
@@ -141,9 +141,9 @@ browser ad blockers. I am using a React component that collects feedback and wri
141141
cookies. Each week a
142142
https://github.com/StarRocks/starrocks/blob/main/.github/workflows/weekly-docs-feedback.yml[scheduled GitHub workflow^,target="_blank"]
143143
collects the feedback from PostHog and generates an issue with the reader feedback. The same workflow queries Algolia
144-
for the top successful searches, and the top failed searches in the docs. This informs the documentation team and
144+
for the top successful searches and failed searches in the docs. This informs the documentation team and
145145
product management on which features or commands are important to readers.
146146

147147
== CI checks
148148

149-
Link checking, Markdown linting, and build tests are done on each commit to documentation pull requests by the https://github.com/StarRocks/starrocks/blob/main/.github/workflows/ci-doc-checker.yml#L62-L135[doc CI job^,target="_blank"].
149+
Link checking, Markdown linting, and build tests are performed on each commit to documentation pull requests by the https://github.com/StarRocks/starrocks/blob/main/.github/workflows/ci-doc-checker.yml#L62-L135[doc CI job^,target="_blank"].

0 commit comments

Comments
 (0)