Proofread and add helpful context in Redis/ConfigMap Tutorial#1
Open
niceredfrog wants to merge 1 commit intomainfrom
Open
Proofread and add helpful context in Redis/ConfigMap Tutorial#1niceredfrog wants to merge 1 commit intomainfrom
niceredfrog wants to merge 1 commit intomainfrom
Conversation
Instructions were: Edit the tutorial as though you’re getting it ready to publish. This tutorial suffers from assumptions about the prior knowledge of the reader. There are some parts that could benefit from reorganization. - Added context about the use case and audience for this tutorial. - Divided the tutorial into numbered steps. - Added (fictional or best-guess) details to help the reader understand the commands in the tutorial. - Added connecting language to show why one step follows another. - Added sections: an Overview of all the steps up top, Why Read This, Who Should Read This, definitions of key Terms, and Troubleshooting - Fixed proofreading items like inconsistent periods in bulleted lists, inconsistent capitalization in heading, capitalization of Pod/pod, Latinisms, above/below
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Instructions were: Edit the tutorial as though you’re getting it ready to publish.
This tutorial suffers from assumptions about the prior knowledge of the reader. There are some parts that could benefit from reorganization.