aboutsummaryrefslogtreecommitdiffhomepage
path: root/site
diff options
context:
space:
mode:
authorGravatar David Chen <dzc@google.com>2016-07-27 00:12:32 +0000
committerGravatar Damien Martin-Guillerez <dmarting@google.com>2016-07-27 11:15:16 +0000
commitf328fde93d308c43eef8d7bd119dd7288de427dc (patch)
tree66105244ac5b49730402bd2fee280e116d284fd7 /site
parentccd5fb14569c259feaac701eef9112ee745267e7 (diff)
Add README to original Bazel docs directory to point developers to the correct
directory to make documentation changes. Bug: #579 -- MOS_MIGRATED_REVID=128533607
Diffstat (limited to 'site')
-rw-r--r--site/BUILD1
-rw-r--r--site/docs/README.md10
2 files changed, 11 insertions, 0 deletions
diff --git a/site/BUILD b/site/BUILD
index ba7fba0f28..52f9da12be 100644
--- a/site/BUILD
+++ b/site/BUILD
@@ -24,6 +24,7 @@ filegroup(
"*.swp",
"command-line-reference-prefix.html",
"command-line-reference-suffix.html",
+ "site/README.md",
],
),
)
diff --git a/site/docs/README.md b/site/docs/README.md
new file mode 100644
index 0000000000..a13f46bf46
--- /dev/null
+++ b/site/docs/README.md
@@ -0,0 +1,10 @@
+# Our documentation is in another directory.
+
+Bazel's documentation is now versioned. This directory contains redirects to
+the latest version of each page.
+
+To make changes to Bazel documentation at HEAD, please edit the files under
+`versions/master`. Once a release is cut, the docs in the `master` directory
+will be snapshotted and copied into a versioned directory for the release.
+
+Happy documenting!