Move doc/index.html to doc/release-index.html

So it can contain other links.
oilshell · Sep 5, 2017 · 20b9cdbef9cc3124634edffc1a4cd2c605fa8cd8 · 20b9cdb
1 parent 14bfa7e
commit 20b9cdbef9cc3124634edffc1a4cd2c605fa8cd8
Unified Split

Showing with 32 additions and 21 deletions.

+3 −2 build/doc.sh

+0 −17 doc/index.md

+24 −0 doc/release-index.md

+4 −1 scripts/release.sh

+1 −1 test/spec.sh
diff --git a/build/doc.sh b/build/doc.sh
@@ -161,9 +161,10 @@ install() {
  markdown2html INSTALL.txt _build/doc/INSTALL.html "$MONOSPACE"
 }

-index() {
+release-index() {
+  local out=${1:-_build/doc/release-index.html}
  # Not monospace
-  markdown2html doc/index.md _build/doc/index.html ''
+  markdown2html doc/release-index.md $out ''
 }

 # I want to ship the INSTALL file literally, so just mutate things
diff --git a/doc/index.md b/doc/index.md
diff --git a/doc/release-index.md b/doc/release-index.md
@@ -0,0 +1,24 @@
+<!-- NOTE: This file is at /release/$VERSION/index.html -->
+
+Oil Version 0.1.alpha1
+======================
+
+Documentation
+--------------
+
+### For End Users
+
+- [INSTALL](doc/INSTALL.html).  How to install OSH.  This text file is also
+  at the root of the tarball.
+- [OSH Quick Reference](doc/osh-quick-ref.html), with Examples.  This document
+  underlies the OSH `help` builtin.
+
+### For Developers
+
+- [Github Wiki for oilshell/oil](https://github.com/oilshell/oil/wiki)
+
+Links
+-----
+
+- [Spec Test Results](test/spec/RESULTS.html)
+- [Metrics](metrics/)
diff --git a/scripts/release.sh b/scripts/release.sh
@@ -35,6 +35,8 @@ log() {
 #         wild/
 #         gold/
 #         tarball/  # log of building and running the tarball?
+#       asan/       # spec tests or other?
+#                   # or it can be put under test/{spec,wild}
 #       metrics/  # static metrics on source code?
 #                 # could also do cloc?
 #         loc-src.txt  # oil, tools, etc.
@@ -162,10 +164,11 @@ deploy-doc() {
  build/doc.sh osh-quick-ref
  # Generate docs.
  build/doc.sh install
-  build/doc.sh index

  cp -v -r --no-target-directory _build/doc/ $release_dir/doc

+  build/doc.sh release-index $release_dir/index.html
+
  tree -L 3 $release_root_dir
  
  ls -l $deploy_repo/releases.html
diff --git a/test/spec.sh b/test/spec.sh
@@ -186,7 +186,7 @@ blog1() {
 }

 blog2() {
-  sh-spec spec/blog2.test.sh --osh-failures-allowed 3 \
+  sh-spec spec/blog2.test.sh \
    ${REF_SHELLS[@]} $ZSH $OSH "$@"
 }