Remove unmaintained docs #67
Conversation
josh-wong
requested review from
feeblefakie,
jnmt,
kota2and3kan and
NatsukiMiyamoto
| > [!CAUTION] | ||
| > | ||
| > The `docs` folder has been moved to the centralized documentation repository, [docs-internal](https://github.com/scalar-labs/docs-internal). Please update this documentation in that repository instead. | ||
| > | ||
| > To view the ScalarDL documentation, visit [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/). |
There was a problem hiding this comment.
I'm not sure, but should we keep this to redirect users to the docs site? Or does the redirection work in other ways? Also, did you intentionally leave the _includes and _layouts?
There was a problem hiding this comment.
should we keep this to redirect users to the docs site? Or does the redirection work in other ways?
This isn't really an automatic redirect, so I don't think we need it anymore. We have a link to the docs site in the About section of the scalar-labs/scalardl home page and in the root README, so I think that should be enough.
Also, did you intentionally leave the _includes and _layouts?
Actually, we don't really need those anymore since they were implemented more than a year ago. I just now removed them in d205338.
There was a problem hiding this comment.
Got it, thank you for the update!
Remove an old redirect that we implemented after launching the Jekyll-based docs sites more than one year ago. This redirect automatically directed users from the GitHub Pages site deployed from the `scalardl` repository to the GitHub Pages site deployed from the `docs-scalardl` repository. Since it's been more than one year and we have links to the docs site in the repository "About" section and root README, I don't think we need this redirect any more.
There was a problem hiding this comment.
@feeblefakie Could you please disable GitHub Pages for this repository since we're removing this old redirect?
There was a problem hiding this comment.
@josh-wong It's unpublished now. Is it OK?
There was a problem hiding this comment.
@feeblefakie I still see the site deployed under https://github.com/scalar-labs/scalardl/deployments/github-pages. In this repository, if you go to Settings > Pages, under Build and deployment, there's a section named Branch. If a branch is selected in the dropdown menu, try selecting None.
If that doesn't work, let's try to unpublish it over a quick screen-sharing session.
Description
This PR removes docs and images since they are now maintained in scalar-labs/docs-internal-scalardl instead of this repository. Since users should now be referencing the ScalarDL docs site and might be confused with seeing the unmaintained docs in this repository, I think we can safely remove the docs from this repository.
Important
I kept some files in the
docsfolder, like the ScalarDL sample code files. In addition, I kept the files that are used to redirect users to the appropriate docs site since there are still a significant amount of visitors (~80) who have clicked that link over the last 90 days.Related issues and/or PRs
Changes made
scalardlrepository to the GitHub Pages site deployed from thedocs-scalardlrepository. Since it's been more than one year and we have links to the docs site in the repository "About" section and root README, I don't think we need this redirect any more.Checklist
Additional notes (optional)
N/A
Release notes
N/A