Radio comedian Roy Atwell, who used stammering in his act and specialized in mixed-up language, was appropriately chosen for the voice of Doc. Disney personally suggested the sequence in which Grumpy feeds him the phrase "mad as hornets" when Doc is lost for words, causing Doc to blurt out Grumpy's words without thinking, and having to go back and correct himself, leading to even more dithering. Several months later, his role in the film and his relationship with Grumpy was established: Walt Disney commented that Doc's flustered personality should be such that he never knew quite where he is without one of his fellow dwarfs reminding him.
#White docs install
Use present tense - Avoid sentences like “this command will install redis”, which implies the action is in the future.It is better to give the reader the explicit command to do this, rather than having them figure this out. Now set an environment variable Dapr to a value X. Assume a new developer audience - Some obvious steps can seem hard.Avoid the first person - Use 2nd person “you”, “your” instead of “I”, “we”, “our”.Use simple sentences - Easy-to-read sentences mean the reader can quickly use the guidance you share.use the above casing guidance for headers and titles too Headers and titles - Headers and titles must be descriptive and clear, use sentence casing i.e.Casing - Use upper case only at the start of a sentence or for proper nouns including names of technologies (Dapr, Redis, Kubernetes etc.).
These conventions should be followed throughout all Dapr documentation to ensure a consistent experience across all docs. Branches can be found in the Docs repo Style and tone If you are documenting an upcoming change to a component or the runtime, make your changes to the pre-release branch. For any docs changes that are applicable to a release candidate or a pre-release version of the docs, make your changes into that particular branch.įor example, if you are fixing a typo, adding notes, or clarifying a point, make your changes into the default Dapr branch. You can find this directly at, as the latest release will be the default branch. Overall, all updates should go into the docs branch for the latest release of Dapr. Instead of having a master or main branch, every branch is labeled to match the major and minor version of a runtime release.
#White docs code
The Dapr docs handles branching differently than most code repositories. To verify docs are built correctly before submitting a contribution, you should setup your local environment to build and display the docs locally.įork the docs repository to work on any changesįollow the instructions in the repository README.md to install Hugo locally and build the docs website. The Dapr docs are built using Hugo with the Docsy theme. Therefore, any contribution must ensure docs can be compiled and published correctly. This guide assumes you have already reviewed the general guidance which applies to any Dapr project contributions.ĭapr docs are published to. Please review the guidelines below before making a contribution to the Dapr docs.
This guide contains information about contributions to the Dapr docs repository.
Guidelines for contributing to the Dapr Docs
0 kommentar(er)
