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

Remove all docs now that they've been deprecated #2021

Closed
ThomasLaPiana opened this issue Dec 10, 2022 · 8 comments · Fixed by #2184
Closed

Remove all docs now that they've been deprecated #2021

ThomasLaPiana opened this issue Dec 10, 2022 · 8 comments · Fixed by #2184
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@ThomasLaPiana
Copy link
Contributor

ThomasLaPiana commented Dec 10, 2022

Docs Update Description

We have a beautiful new docs site now, so it is time to retire the old one.

We can remove the docs subdir as well as associated CI workflows, nox sessions, etc.

@ThomasLaPiana ThomasLaPiana added the documentation Improvements or additions to documentation label Dec 10, 2022
@ThomasLaPiana ThomasLaPiana self-assigned this Dec 10, 2022
@ThomasLaPiana
Copy link
Contributor Author

@conceptualshark are you ok with this change?

@conceptualshark
Copy link
Contributor

I am! Suchi is going to (or has) put in a a banner message that we've moved the docs, so I think we should leave the build in place for a sprint or two to make sure that's clear?

@ThomasLaPiana
Copy link
Contributor Author

we'll need to update any code references to it, can we also directly do a redirect from the current url to the new docs site?

@conceptualshark
Copy link
Contributor

I believe @suchiroll looked into it and a redirect wasn't possible (so we went with a banner) - let me confirm a process/timeline for when we want to remove everything, and I can get back to you!

@ThomasLaPiana
Copy link
Contributor Author

@conceptualshark ok, so let me clarify the current situation a bit:

  1. We have a new docs site (docs.ethyca.com/fides/overview)
  2. We have an old docs site (ethyca.github.io/fides) that we are pointing to in some places

I have a few questions:

  1. What is pointing to the old docs site?
  2. What is pointing to the old docs site that we can't update?
  3. How long do you propose keeping the old site around for?
  4. How do we handle docs updates during this transition period?

@seanpreston
Copy link
Contributor

Hey @ThomasLaPiana — do we have the knowledge in the eng. team at this time to keep the new docs up to date? If not, I'll add a ticket to action that.

@ThomasLaPiana
Copy link
Contributor Author

@seanpreston nope, I don't think the new docs processes have been communicated

@ThomasLaPiana ThomasLaPiana mentioned this issue Jan 5, 2023
12 tasks
@ThomasLaPiana ThomasLaPiana mentioned this issue Jan 18, 2023
9 tasks
@ThomasLaPiana
Copy link
Contributor Author

Closed this via refactoring the docs

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

Successfully merging a pull request may close this issue.

3 participants