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