Skip to content
This repository has been archived by the owner on Apr 16, 2021. It is now read-only.

Create 087-deprecating-the-old-docs-site.md #387

Closed
wants to merge 18 commits into from
Closed

Create 087-deprecating-the-old-docs-site.md #387

wants to merge 18 commits into from

Conversation

johnnymatthews
Copy link
Contributor

Wrote a post explaining why we're deprecating the legacy docs site, when we're gonna do it, and how we're gonna do it. Criticism requested, and any ideas for images/other media.

Copy link
Contributor

@jessicaschilling jessicaschilling left a comment

Choose a reason for hiding this comment

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

Added some changes ... and also strongly encourage you to run this past @cwaring as well, thanks!

content/post/087-deprecating-the-old-docs-site.md Outdated Show resolved Hide resolved
content/post/087-deprecating-the-old-docs-site.md Outdated Show resolved Hide resolved
content/post/087-deprecating-the-old-docs-site.md Outdated Show resolved Hide resolved
content/post/087-deprecating-the-old-docs-site.md Outdated Show resolved Hide resolved
content/post/087-deprecating-the-old-docs-site.md Outdated Show resolved Hide resolved
content/post/087-deprecating-the-old-docs-site.md Outdated Show resolved Hide resolved
content/post/087-deprecating-the-old-docs-site.md Outdated Show resolved Hide resolved
johnnymatthews and others added 7 commits March 30, 2020 18:23
Co-Authored-By: Jessica Schilling <jessica@protocol.ai>
Co-Authored-By: Jessica Schilling <jessica@protocol.ai>
Co-Authored-By: Jessica Schilling <jessica@protocol.ai>
Nice catch!

Co-Authored-By: Jessica Schilling <jessica@protocol.ai>
Co-Authored-By: Jessica Schilling <jessica@protocol.ai>
Co-Authored-By: Jessica Schilling <jessica@protocol.ai>
@johnnymatthews
Copy link
Contributor Author

Thanks for the review @jessicaschilling! Yeah @cwaring, would super appreciate it if you could give this a once-over when you get a chance.

@jennwrites
Copy link
Contributor

Are we kicking off a series here, because I'm wondering if we could punch that up by adding more of a narrative and maybe tap design assets for a header? Anyway, I think there's an opportunity for a CTA to contribute in the conclusion.

@johnnymatthews
Copy link
Contributor Author

@renrutnnej I wasn't planning on creating a series, this was meant as a one-off. Can't really think of anything else I'd say. Did you have something else in mind that might be handy to talk about?

@cwaring
Copy link
Contributor

cwaring commented Mar 31, 2020

👋 hi folks, I'm deep in the dev sprints on the other special project at the moment but I'd like to check in about all this before rolling out a full plan to the public.

A couple of important notes: we need to create a 404 search page using the Algolia engine and enable robot crawling so we don't lose our SEO position, plus it would be best to transfer the issues and rename the repos so that we can retain commit history.

I know a bunch of things have not made the cut during the beta cycle due to other priorities so if we intend to complete this migration before I'm finished on other work it might be best for me to brief another dev that can help out in the meantime.

LMK and we can aim to sync up over the next week to discuss in detail ✨

@johnnymatthews
Copy link
Contributor Author

johnnymatthews commented Mar 31, 2020

I'd much rather we wait until you've got time to help out with the deprecation @cwaring. No doubt someone else could pick up the project, but it'd be much smoother sailing with you at the helm.

Do you have a guestimation on when you'll be done with the other special project? If it's not going to be for a while, then we can discuss getting another dev on board. But if you'll be available fairly soonish (weeks, not months), then we can probably hang on.

Co-Authored-By: MollyM <momack2@users.noreply.github.com>
1. Remove the _this URL has changed_ notices in any existing pages.
2. Re-crawl the site to make sure all the links and references are still working and up to date.
3. Check the top 404 referrers, and create a fix for them where possible.
4. Search all content in the IPFS and Protocol Labs GitHub orgs for references to old site pages, and fix those (so we don’t 404 ourselves!).
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm confused about which docs you are referencing here (links to the docs-v2? links to ipfs.docs?) and also why we expect to be hitting so many 404s in our existing docs/orgs

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Re-crawl the site to make sure all the links and references are still working and up to date.

The new docs site. There's a plan to automate this step however, so this point isn't necessary.

Check the top 404 referrers, and create a fix for them where possible.

If there are links coming in from external sites (other GitHub repos, tutorials, forum posts, etc) that are wrong, we can either redirect them to the homepage of docs, or redirect them to the most relevant page. Obviously the plan is to have no internal broken links.

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

Successfully merging this pull request may close these issues.

5 participants