Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add warning to docs fetched by docs.nextstrain.org #634

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

eharkins
Copy link
Contributor

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

@eharkins eharkins requested a review from tsibley November 20, 2020 20:36
@codecov
Copy link

codecov bot commented Nov 20, 2020

Codecov Report

Merging #634 (3271a58) into master (f75f05e) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #634   +/-   ##
=======================================
  Coverage   28.68%   28.68%           
=======================================
  Files          39       39           
  Lines        5389     5389           
  Branches     1326     1326           
=======================================
  Hits         1546     1546           
  Misses       3785     3785           
  Partials       58       58           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f75f05e...3271a58. Read the comment docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant