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

Cleanup Legacy docs #2184

Merged
merged 4 commits into from
Jan 11, 2023
Merged

Cleanup Legacy docs #2184

merged 4 commits into from
Jan 11, 2023

Conversation

ThomasLaPiana
Copy link
Contributor

@ThomasLaPiana ThomasLaPiana commented Jan 10, 2023

Closes #2021

Code Changes

  • landing page action item to visit new docs site
  • remove redundant docs pages

Steps to Confirm

  • nox -s docs_serve and poke around

Pre-Merge Checklist

Description Of Changes

Removes all of the pages that are now made redundant and encourages visitors to go to the new docs site. Retains the helpful autogenerated docs and developer-centric pages

Note that all remaining docs infrastructure remains in place, new docs versions will be continually pushed out, etc. The change here is the removal of redundant docs pages and pointing users to the new ones.

@ThomasLaPiana ThomasLaPiana self-assigned this Jan 10, 2023
@ThomasLaPiana ThomasLaPiana marked this pull request as ready for review January 10, 2023 06:40
Copy link
Contributor

@sanders41 sanders41 left a comment

Choose a reason for hiding this comment

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

I tested and all seems good. My only question is why do we want two different docs sites? Why not just put everything in one place?

@ThomasLaPiana
Copy link
Contributor Author

I tested and all seems good. My only question is why do we want two different docs sites? Why not just put everything in one place?

Good question...

  1. We have a lot of legacy marketing materials that point to these docs URL, so for that reason we want to at least push people towards the new docs site if they end up at the legacy site
  2. With the new site we lost the ability to integrate the autogenerated docs (CLI and API) which in my opinion are actually critical...so this will be the "engineering-led" docs area that still includes some of those critical autogenerated pieces

Ideally I'd like to move the new docs site back into this repo to decrease the friction of engineers contributing to docs directly, but that is something we'll tackle down the road

@ThomasLaPiana ThomasLaPiana merged commit 8fa5082 into main Jan 11, 2023
@ThomasLaPiana ThomasLaPiana deleted the ThomasLaPiana-cleanup-legacy-docs branch January 11, 2023 07:47
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.

Remove all docs now that they've been deprecated
2 participants