Update documentation development instructions and codeowners (quantum…

…lib#4990) Getting ready for docs work by making a quick update to the dev instructions and codeowners.
95-martin-orion · Mar 2, 2022 · 71b1719 · 71b1719
1 parent d38c71e
commit 71b1719
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 26 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -24,35 +24,35 @@ cirq-rigetti/**/*.* @erichulburd @kalzoo @dbanty @quantumlib/cirq-maintainers @v
 
 cirq-core/cirq/experiments/**/*.* @mrwojtek @quantumlib/cirq-maintainers @vtomole @cduck
 
-###########################################
-# docs maintainers: maintainers + @rmlarose
-###########################################
+#####################################################
+# docs maintainers: maintainers + @aasfaw + @rmlarose
+#####################################################
 
-docs/**/*.* @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck
+docs/**/*.* @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck
 
-##########################################################
-# vendor docs maintainers: vendor maintainers + @rmlarose
-############################################################
+###################################################################
+# vendor docs maintainers: vendor maintainers + @aasfaw + @rmlarose
+###################################################################
 
-docs/google/**/*.* @wcourtney @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck @verult
-docs/tutorials/google/**/*.* @wcourtney @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck @verult
+docs/google/**/*.* @wcourtney @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck @verult
+docs/tutorials/google/**/*.* @wcourtney @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck @verult
 
-docs/ionq/**/*.* @dabacon @ColemanCollins @nakardo @gmauricio @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck
-docs/tutorials/ionq/**/*.* @dabacon @ColemanCollins @nakardo @gmauricio @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck
+docs/ionq/**/*.* @dabacon @ColemanCollins @nakardo @gmauricio @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck
+docs/tutorials/ionq/**/*.* @dabacon @ColemanCollins @nakardo @gmauricio @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck
 
-docs/aqt/**/*.* @ma5x @pschindler @alfrisch @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck
-docs/tutorials/aqt/**/*.* @ma5x @pschindler @alfrisch @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck
+docs/aqt/**/*.* @ma5x @pschindler @alfrisch @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck
+docs/tutorials/aqt/**/*.* @ma5x @pschindler @alfrisch @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck
 
-docs/pasqal/**/*.* @HGSilveri @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck
-docs/tutorials/pasqal/**/*.* @HGSilveri @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck
+docs/pasqal/**/*.* @HGSilveri @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck
+docs/tutorials/pasqal/**/*.* @HGSilveri @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck
 
-docs/rigetti/**/*.* @erichulburd @kalzoo @dbanty @quantumlib/cirq-maintainers @vtomole @cduck
-docs/tutorials/rigetti/**/*.* @erichulburd @kalzoo @dbanty @quantumlib/cirq-maintainers @vtomole @cduck
+docs/rigetti/**/*.* @erichulburd @kalzoo @dbanty @aasfaw @quantumlib/cirq-maintainers @vtomole @cduck
+docs/tutorials/rigetti/**/*.* @erichulburd @kalzoo @dbanty @aasfaw @quantumlib/cirq-maintainers @vtomole @cduck
 
-docs/azure-quantum/**/*.* @guenp @anpaz @quantumlib/cirq-maintainers @vtomole @cduck
-docs/tutorials/azure-quantum/**/*.* @guenp @anpaz @quantumlib/cirq-maintainers @vtomole @cduck
+docs/azure-quantum/**/*.* @guenp @anpaz @aasfaw @quantumlib/cirq-maintainers @vtomole @cduck
+docs/tutorials/azure-quantum/**/*.* @guenp @anpaz @aasfaw @quantumlib/cirq-maintainers @vtomole @cduck
 
-#####################################################
-# qcvv docs maintainers: docs maintainers + mrwojtek
-#####################################################
-docs/qcvv/**/*.* @mrwojtek @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck
+#############################################################
+# qcvv docs maintainers: docs maintainers + mrwojtek + aasfaw
+#############################################################
+docs/qcvv/**/*.* @mrwojtek @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck
diff --git a/dev_tools/codeowners_test.py b/dev_tools/codeowners_test.py
@@ -19,7 +19,7 @@
 
 BASE_MAINTAINERS = {CIRQ_MAINTAINERS, ('USERNAME', "@vtomole"), ('USERNAME', "@cduck")}
 
-DOCS_MAINTAINERS = BASE_MAINTAINERS.union({('USERNAME', '@rmlarose')})
+DOCS_MAINTAINERS = BASE_MAINTAINERS.union({('USERNAME', '@aasfaw'), ('USERNAME', '@rmlarose')})
 
 GOOGLE_TEAM = {('USERNAME', "@wcourtney"), ('USERNAME', "@verult")}
 

diff --git a/docs/dev/development.md b/docs/dev/development.md
@@ -303,8 +303,7 @@ def some_method(a: int, b: str) -> float:
     """
 ```
 
-Currently the docs folder serves two sites: the new site that is under construction and the current site that is deployed to readthedocs.io. 
-The new site is currently not available for preview just yet. For the current site, documentation is generated automatically by readthedocs when pushing to `master`, but you can also generate a local copy by running:
+The docs folder is used to automatically generate the documentation on our website at [quantumai.google/cirq](https://quantumai.google/cirq) from the `master` branch. You can also generate a local copy by running:
 
 ```bash
 dev_tools/docs/build-rtd-docs.sh