Merge pull request #1234 from nextstrain/warn-fetched-docs

Add warning to docs fetched by docs.nextstrain.org
nextstrain · Dec 15, 2020 · 95dc21b · 95dc21b
2 parents 6a2d0f2 + c3fe29f
commit 95dc21b
Show file tree

Hide file tree

Showing 5 changed files with 53 additions and 0 deletions.
diff --git a/DEV_DOCS.md b/DEV_DOCS.md
@@ -1,4 +1,15 @@
 # Contributing to Auspice development
+<!-- WARNING -->
+<!-- Do not edit this file from within the docs.nextstrain.org repository. -->
+<!-- It is fetched from another repository to be included in the docs.nextstrain.org build. -->
+<!-- So, if you edit it after it is fetched into docs.nextstrain.org, your changes will be lost. -->
+<!-- Instead, edit this file in its own repository and commit your changes there. -->
+<!-- For more details on this (temporary) implementation, see https://github.com/nextstrain/docs.nextstrain.org#fetching-of-documents-from-other-repositories -->
+<!-- This file is located at (fetched from): https://github.com/nextstrain/auspice/blob/master/DEV_DOCS.md -->
+<!-- WARNING -->
+<!-- WARNING -->
+<!-- WARNING -->
+
 
 Thank you for helping us to improve Nextstrain!
 

diff --git a/docs/introduction/install.md b/docs/introduction/install.md
@@ -1,4 +1,14 @@
 # Install Auspice
+<!-- WARNING -->
+<!-- Do not edit this file from within the docs.nextstrain.org repository. -->
+<!-- It is fetched from another repository to be included in the docs.nextstrain.org build. -->
+<!-- So, if you edit it after it is fetched into docs.nextstrain.org, your changes will be lost. -->
+<!-- Instead, edit this file in its own repository and commit your changes there. -->
+<!-- For more details on this (temporary) implementation, see https://github.com/nextstrain/docs.nextstrain.org#fetching-of-documents-from-other-repositories -->
+<!-- This file is located at (fetched from): https://github.com/nextstrain/auspice/blob/master/docs/introduction/install.md -->
+<!-- WARNING -->
+<!-- WARNING -->
+<!-- WARNING -->
 
 ## Prerequisites
 Auspice is a JavaScript program, and requires [Node.js](https://nodejs.org/) to be installed on your system.

diff --git a/docs/narratives/create-pdf.md b/docs/narratives/create-pdf.md
@@ -1,4 +1,14 @@
 # Converting a narrative to PDF
+<!-- WARNING -->
+<!-- Do not edit this file from within the docs.nextstrain.org repository. -->
+<!-- It is fetched from another repository to be included in the docs.nextstrain.org build. -->
+<!-- So, if you edit it after it is fetched into docs.nextstrain.org, your changes will be lost. -->
+<!-- Instead, edit this file in its own repository and commit your changes there. -->
+<!-- For more details on this (temporary) implementation, see https://github.com/nextstrain/docs.nextstrain.org#fetching-of-documents-from-other-repositories -->
+<!-- This file is located at (fetched from): https://github.com/nextstrain/auspice/blob/master/docs/narratives/create-pdf.md -->
+<!-- WARNING -->
+<!-- WARNING -->
+<!-- WARNING -->
 
 This documentation will walk through how to turn a narrative into a static PDF.
 We understand that there are multiple reasons why PDFs may be a necessary method of distribution, but stress that narratives are designed to be viewed through auspice where you have the ability to interact with and interrogate the data.

diff --git a/docs/narratives/how-to-write.md b/docs/narratives/how-to-write.md
@@ -1,4 +1,15 @@
 # Writing a Narrative
+<!-- WARNING -->
+<!-- Do not edit this file from within the docs.nextstrain.org repository. -->
+<!-- It is fetched from another repository to be included in the docs.nextstrain.org build. -->
+<!-- So, if you edit it after it is fetched into docs.nextstrain.org, your changes will be lost. -->
+<!-- Instead, edit this file in its own repository and commit your changes there. -->
+<!-- For more details on this (temporary) implementation, see https://github.com/nextstrain/docs.nextstrain.org#fetching-of-documents-from-other-repositories -->
+<!-- This file is located at (fetched from): https://github.com/nextstrain/auspice/blob/master/docs/narratives/how-to-write.md -->
+<!-- WARNING -->
+<!-- WARNING -->
+<!-- WARNING -->
+
 
 
 This documentation will walk us through constructing a narrative from scratch, based on [this example (nextstrain.org)](https://nextstrain.org/narratives/intro-to-narratives).

diff --git a/docs/narratives/introduction.md b/docs/narratives/introduction.md
@@ -1,4 +1,15 @@
 # Communicating Results Using Narratives
+<!-- WARNING -->
+<!-- Do not edit this file from within the docs.nextstrain.org repository. -->
+<!-- It is fetched from another repository to be included in the docs.nextstrain.org build. -->
+<!-- So, if you edit it after it is fetched into docs.nextstrain.org, your changes will be lost. -->
+<!-- Instead, edit this file in its own repository and commit your changes there. -->
+<!-- For more details on this (temporary) implementation, see https://github.com/nextstrain/docs.nextstrain.org#fetching-of-documents-from-other-repositories -->
+<!-- This file is located at (fetched from): https://github.com/nextstrain/auspice/blob/master/docs/narratives/introduction.md -->
+<!-- WARNING -->
+<!-- WARNING -->
+<!-- WARNING -->
+
 
 Narratives are a method of data-driven storytelling.
 They allow scientists (or anyone!) to author content which is displayed alongside the "normal" Auspice view of the data.