From a4c6be78f4ba53ba1e8732f8f5815057378374c7 Mon Sep 17 00:00:00 2001 From: Tom Clegg Date: Fri, 12 Apr 2013 16:20:50 -0700 Subject: [PATCH 1/1] add "incomplete" alert boxes --- doc/_includes/alert-incomplete.html | 5 +++++ doc/_includes/alert-stub.html | 5 +++++ doc/admin/index.md | 2 ++ doc/api/job-task.textile | 2 ++ doc/install/index.md | 2 ++ doc/user/intro-git.md | 2 ++ doc/user/intro-keep.md | 3 +++ doc/user/provenance.md | 2 ++ doc/user/sample-pipeline.md | 2 ++ doc/user/sdk-cli.md | 2 ++ doc/user/ssh-access.md | 2 ++ 11 files changed, 29 insertions(+) create mode 100644 doc/_includes/alert-incomplete.html create mode 100644 doc/_includes/alert-stub.html diff --git a/doc/_includes/alert-incomplete.html b/doc/_includes/alert-incomplete.html new file mode 100644 index 0000000000..972ba15857 --- /dev/null +++ b/doc/_includes/alert-incomplete.html @@ -0,0 +1,5 @@ +
+ +

Hi!

+

This section is incomplete. Please be patient with us as we fill in the blanks — or contribute to the documentation project.

+
diff --git a/doc/_includes/alert-stub.html b/doc/_includes/alert-stub.html new file mode 100644 index 0000000000..94e6489023 --- /dev/null +++ b/doc/_includes/alert-stub.html @@ -0,0 +1,5 @@ +
+ +

Hi!

+

This section is incomplete. Please be patient with us as we fill in the blanks — or contribute to the documentation project.

+
diff --git a/doc/admin/index.md b/doc/admin/index.md index b8630ef383..5c7541279d 100644 --- a/doc/admin/index.md +++ b/doc/admin/index.md @@ -5,6 +5,8 @@ title: Overview navorder: 0 --- +{% include alert-stub.html %} + # Administration Overview Unlike other users, administrators diff --git a/doc/api/job-task.textile b/doc/api/job-task.textile index f68dd80b67..a17cb99cc2 100644 --- a/doc/api/job-task.textile +++ b/doc/api/job-task.textile @@ -5,6 +5,8 @@ title: Job tasks navorder: 5 --- +{% include alert-incomplete.html %} + h1. Job scripts ...how to understand and write them. diff --git a/doc/install/index.md b/doc/install/index.md index 7bdbc7b14b..2242b68797 100644 --- a/doc/install/index.md +++ b/doc/install/index.md @@ -5,6 +5,8 @@ title: Overview navorder: 0 --- +{% include alert-stub.html %} + # Installation Overview 1. Set up a cluster, or use Amazon diff --git a/doc/user/intro-git.md b/doc/user/intro-git.md index 4d7d98c54b..e6ecd88949 100644 --- a/doc/user/intro-git.md +++ b/doc/user/intro-git.md @@ -5,6 +5,8 @@ title: "Intro: git" navorder: 4 --- +{% include alert-stub.html %} + # Using git Git is a revision control system. There are lots of resources for diff --git a/doc/user/intro-keep.md b/doc/user/intro-keep.md index 0472ddf2ec..2a5f16b5b0 100644 --- a/doc/user/intro-keep.md +++ b/doc/user/intro-keep.md @@ -83,6 +83,9 @@ Output: foo + +{% include alert-stub.html %} + ### Writing a collection ### Reading a file from a collection diff --git a/doc/user/provenance.md b/doc/user/provenance.md index 0e92daf47a..93983c96b1 100644 --- a/doc/user/provenance.md +++ b/doc/user/provenance.md @@ -5,6 +5,8 @@ title: Provenance navorder: 8 --- +{% include alert-stub.html %} + # Provenance Arvados provides features for tracking and inspecting provenance, diff --git a/doc/user/sample-pipeline.md b/doc/user/sample-pipeline.md index fa4e151291..5c683c0958 100644 --- a/doc/user/sample-pipeline.md +++ b/doc/user/sample-pipeline.md @@ -5,6 +5,8 @@ title: A sample pipeline navorder: 10 --- +{% include alert-stub.html %} + # A sample pipeline You should do this. diff --git a/doc/user/sdk-cli.md b/doc/user/sdk-cli.md index 984cada252..0cf2766e98 100644 --- a/doc/user/sdk-cli.md +++ b/doc/user/sdk-cli.md @@ -5,6 +5,8 @@ title: Command line SDK navorder: 10 --- +{% include alert-stub.html %} + # Command line SDK If you are logged in to an Arvados VM, the command line SDK is diff --git a/doc/user/ssh-access.md b/doc/user/ssh-access.md index b9c9ba7f32..2c84ef7e72 100644 --- a/doc/user/ssh-access.md +++ b/doc/user/ssh-access.md @@ -56,6 +56,8 @@ what your account name is for each one.) ### Setup instructions for PuTTY +{% include alert-stub.html %} + If you use Microsoft Windows, you should download the PuTTY software. * Details about configuring PuTTY would be nice here. -- 2.30.2