diff options
Diffstat (limited to 'documentation/README')
-rw-r--r-- | documentation/README | 39 |
1 files changed, 36 insertions, 3 deletions
diff --git a/documentation/README b/documentation/README index b60472fcbf..c394ab9288 100644 --- a/documentation/README +++ b/documentation/README | |||
@@ -165,7 +165,15 @@ To run Vale: | |||
165 | 165 | ||
166 | $ make stylecheck | 166 | $ make stylecheck |
167 | 167 | ||
168 | Link checking the Yocto Project documentation | 168 | Style checking the whole documentation might take some time and generate a |
169 | lot of warnings/errors, thus one can run Vale on a subset of files or | ||
170 | directories: | ||
171 | |||
172 | $ make stylecheck VALEDOCS=<file> | ||
173 | $ make stylecheck VALEDOCS="<file1> <file2>" | ||
174 | $ make stylecheck VALEDOCS=<dir> | ||
175 | |||
176 | Lint checking the Yocto Project documentation | ||
169 | ============================================= | 177 | ============================================= |
170 | 178 | ||
171 | To fix errors which are not reported by Sphinx itself, | 179 | To fix errors which are not reported by Sphinx itself, |
@@ -179,6 +187,14 @@ To run sphinx-lint: | |||
179 | 187 | ||
180 | $ make sphinx-lint | 188 | $ make sphinx-lint |
181 | 189 | ||
190 | Lint checking the whole documentation might take some time and generate a | ||
191 | lot of warnings/errors, thus one can run sphinx-lint on a subset of files | ||
192 | or directories: | ||
193 | |||
194 | $ make sphinx-lint SPHINXLINTDOCS=<file> | ||
195 | $ make sphinx-lint SPHINXLINTDOCS="<file1> <file2>" | ||
196 | $ make sphinx-lint SPHINXLINTDOCS=<dir> | ||
197 | |||
182 | Sphinx theme and CSS customization | 198 | Sphinx theme and CSS customization |
183 | ================================== | 199 | ================================== |
184 | 200 | ||
@@ -413,5 +429,22 @@ both the Yocto Project and BitBake manuals: | |||
413 | Submitting documentation changes | 429 | Submitting documentation changes |
414 | ================================ | 430 | ================================ |
415 | 431 | ||
416 | Please see the top level README file in this repository for details of where | 432 | Please refer to our contributor guide here: https://docs.yoctoproject.org/contributor-guide/ |
417 | to send patches. | 433 | for full details on how to submit changes. |
434 | |||
435 | As a quick guide, patches should be sent to docs@lists.yoctoproject.org | ||
436 | The git command to do that would be: | ||
437 | |||
438 | git send-email -M -1 --to docs@lists.yoctoproject.org | ||
439 | |||
440 | The 'To' header can be set as default for this repository: | ||
441 | |||
442 | git config sendemail.to docs@lists.yoctoproject.org | ||
443 | |||
444 | Now you can just do 'git send-email origin/master..' to send all local patches. | ||
445 | |||
446 | Read the other sections in this document and documentation/standards.md for | ||
447 | rules to follow when contributing to the documentation. | ||
448 | |||
449 | Git repository: https://git.yoctoproject.org/yocto-docs | ||
450 | Mailing list: docs@lists.yoctoproject.org | ||