Skip to content

Commit 81da46c

Browse files
authored
Merge pull request #81 from deerskindoll/fix-image-description
fix: fixed image description
2 parents 7cfef46 + 262115d commit 81da46c

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

_posts/2024-08-09-contributing-to-eclipse-che-docs.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ featuring tools you need to create and test your content.
1818
And from the initial draft to submitting a PR,
1919
everything is happening in the environment you're already familiar with: an Eclipse Che cloud development environment (CDE).
2020

21+
.An Eclipse Che CDE created from the che-docs repository.
2122
image::/assets/img/contributing-to-eclipse-che-docs/workspace-with-preview.png[An Eclipse Che CDE created from the che-docs repository.]
2223

2324

@@ -60,6 +61,7 @@ you need for writing Eclipse Che content.
6061
When you launch the che-docs workspace for the first time,
6162
these extensions are installed automatically:
6263

64+
.Overview of automatically installed extensions, including the Vale extension.
6365
image::/assets/img/contributing-to-eclipse-che-docs/extensions.png["Overview of automatically installed extensions, including the Vale extension."]
6466

6567
You can start working immediately,
@@ -101,6 +103,7 @@ Here are a few tips that will help you write great technical content:
101103
* Keep the focus on the user. Write the content around what the user can achieve when they follow your instructions.
102104
* Keep passive voice to a minimum.
103105

106+
.The famous opening lines of Jane Austen's Pride and Prejudice novel don't follow any of the writing tips listed in this blog post. At grade 16, they also have a very high readability score in the Hemingway Editor. Your technical document should have a readability score between grade 9 and 11.
104107
image::/assets/img/contributing-to-eclipse-che-docs/pp-hemingway.png["The famous opening lines of Jane Austen's Pride and Prejudice novel don't follow any of the writing tips listed in this blog post. At grade 16, they also have a very high readability score in the Hemingway Editor. Your technical document should have a readability score between grade 9 and 11."]
105108

106109

0 commit comments

Comments
 (0)