From 2a7df5e07b4d6479580803e12e4bd182509fd90e Mon Sep 17 00:00:00 2001 From: Sandra McCann Date: Tue, 21 Jul 2020 17:00:47 -0400 Subject: [PATCH] add note for write permission on rst files (#70766) * add note for write permission on rst files * Update docs/docsite/rst/community/documentation_contributions.rst Co-authored-by: Toshio Kuratomi --- docs/docsite/rst/community/documentation_contributions.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/docsite/rst/community/documentation_contributions.rst b/docs/docsite/rst/community/documentation_contributions.rst index cd184b52c30..53e6387fa54 100644 --- a/docs/docsite/rst/community/documentation_contributions.rst +++ b/docs/docsite/rst/community/documentation_contributions.rst @@ -102,6 +102,10 @@ You can drop ``--user`` if you have set up a virtual environment (venv/virtenv). On macOS with Xcode, you may need to install ``six`` and ``pyparsing`` with ``--ignore-installed`` to get versions that work with ``sphinx``. +.. note:: + + After checking out ``ansible/ansible``, make sure the ``docs/docsite/rst`` directory has strict enough permissions. It should only be writable by the owner's account. If your default ``umask`` is not 022, you can use ``chmod go-w docs/docsite/rst`` to set the permissions correctly in your new branch. Optionally, you can set your ``umask`` to 022 to make all newly created files on your system (including those created by ``git clone``) have the correct permissions. + .. _testing_documentation_locally: Testing the documentation locally