Add warning to docs fetched by docs.nextstrain.org #634
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of proposed changes
Background / context:
We fetch some docs from this repository into docs.nextstrain.org (see above) to include them in the build for that repository (ie the main docs build). This adds warnings to the first few lines of every such file in this repository, so that if one were to open such a file in docs.nextstrain.org and try to edit it there as if it belonged in that repository, one would hopefully be reminded where the file actually came from and edit it there (here in this repository). It seems it would otherwise be easy to make this mistake and so this warning seems warranted and hopefully will resolve confusion until we have a different, hopefully more intuitive, implementation - namely nextstrain/docs.nextstrain.org#27.
If we don't like having these warnings permanently added to documents in this repository, we could always inject the warning into files once they are fetched into docs.nextstrain.org.
Testing
Local build works and warnings do not appear in the built version of docs.nextstrain.org