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

Redirect /docs and /help to docs.nextstrain.org #226

Merged
merged 10 commits into from
Nov 12, 2020
Merged

Conversation

eharkins
Copy link
Contributor

Description of proposed changes

As per nextstrain/docs.nextstrain.org#13, we need to send what used to be nextstrain.org/docs and nextstrain.org/help both over to docs.nextstrain.org since we are migrating our documentation there. This does that in three steps:

  • replace all the links (e.g. in the navigation bar at the top of nextstrain.org) which previously when to these pages to external links that send you to docs.nextstrain.org
  • redirect all current nextstrain.org/docs/* and nextstrain.org/help/* urls to the corresponding pages at docs.nextstrain.org
  • remove the (mostly markdown) content that we have migrated to docs.nextstrain.org from this repository, so that Gatsby no longer builds it into the static site.

Related issue(s)

nextstrain/docs.nextstrain.org#13
nextstrain/docs.nextstrain.org#35 (in case we want to adjust redirects for clade labeling page)

Testing

I've just been testing this locally with gatsby (npm run dev in static-site and npm run server from the root directory), checking that redirects work and clicking on external links to docs.nextstrain.org. I will deploy this on heroku to test today.

send /docs and /help individual pages to
their corresponding pages on docs.nextstrain.org
@tsibley tsibley temporarily deployed to nextstrain-s-migrate-do-bawcjp October 29, 2020 18:27 Inactive
@@ -2,6 +2,7 @@
author: "James Hadfield"
date: "2019-10-21"
title: "Auspice v2 released"
anchorText: "Auspice v2"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's necessary to have at least one instance of anchorText or else gatsby will complain.

@tsibley tsibley temporarily deployed to nextstrain-s-migrate-do-cmqylv October 29, 2020 19:17 Inactive
@eharkins eharkins temporarily deployed to nextstrain-s-migrate-do-cmqylv October 29, 2020 20:20 Inactive
@eharkins
Copy link
Contributor Author

Upon or before merging, we'll want to remove the banner from the docs.nextstrain.org home page (https://github.com/nextstrain/docs.nextstrain.org/blob/master/src/index.rst) that says:

This site is currently only a stub, to show what's possible with Read The Docs for an umbrella documentation project.
For the real documentation entry point, please go to nextstrain.org/docs.

Since going to nextstrain.org/docs will redirect back to docs.nextstrain.org.

Copy link
Member

@jameshadfield jameshadfield left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good @eharkins - have left specific line-comments for minor changes. Thanks!

auspice-client/customisations/navbar.js Outdated Show resolved Hide resolved
redirects.js Show resolved Hide resolved
static-site/src/components/nav-bar/index.jsx Outdated Show resolved Hide resolved
static-site/src/components/sars-cov-2/builds.jsx Outdated Show resolved Hide resolved
static-site/src/components/splash/index.jsx Outdated Show resolved Hide resolved
static-site/src/components/splash/index.jsx Outdated Show resolved Hide resolved
static-site/src/components/splash/index.jsx Outdated Show resolved Hide resolved
redirects.js Show resolved Hide resolved
@eharkins eharkins temporarily deployed to nextstrain-s-migrate-do-cmqylv November 2, 2020 20:41 Inactive
@eharkins
Copy link
Contributor Author

eharkins commented Nov 2, 2020

@jameshadfield 4d30a24 should resolve all of the above, let me know if it's not the case, thanks for the review!

redirects.js Outdated Show resolved Hide resolved
Copy link
Contributor Author

@eharkins eharkins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Merging nextstrain/docs.nextstrain.org#36 would / will mean some updates are needed here. Since there were only a few changes I just added them in comment suggestions which we can add, instead of creating yet another PR into this one.

redirects.js Outdated Show resolved Hide resolved
redirects.js Outdated Show resolved Hide resolved
redirects.js Outdated Show resolved Hide resolved
@jameshadfield jameshadfield merged commit d9df53e into master Nov 12, 2020
@jameshadfield jameshadfield deleted the migrate-docs branch November 12, 2020 02:30
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.

3 participants