Skip to content

Remove defunct deploy-demo make action #678

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

Merged
merged 1 commit into from
Mar 21, 2025
Merged

Conversation

nrichers
Copy link
Collaborator

Internal Notes for Reviewers

This PR removes one of those 'we should fix this some day' annoyances that I've spent more time explaining in the last week than it would take to fix. This PR fixes THE LAST PIECE in the puzzle.

Before
We had an extra docs site in the root of the s3://docs-ci-cd-demo bucket that goes back to the very early days of Andres and I experimenting with docs deployment. This site serves no purpose, is not current, and is not used — other than we need in index.html in the root of origin/ for the PR previews to work.

You could deploy this site with make deploy-demo.

After
This site has now been deleted, replaced with an index.html that redirects to https://docs-staging.validmind.ai/ if you try to access the root of origin/. Eventually, we might want to list all the PR previews but for now, not having a stale, defunct docs site kicking around that I have to explain is an improvement.

The make deploy-demo is removed in this PR, preventing accidental redeployment of the site.

External Release Notes

@nrichers nrichers added infrastructure Docs infra changes internal Not to be externalized in the release notes labels Mar 20, 2025
@nrichers nrichers force-pushed the remove-deploy-demo-action branch from 2b3094a to 44daca4 Compare March 20, 2025 22:07
@nrichers nrichers force-pushed the remove-deploy-demo-action branch from 44daca4 to 5d09c8a Compare March 20, 2025 22:11
@nrichers nrichers requested review from validbeck and nibalizer March 20, 2025 22:20
Copy link
Contributor

PR Summary

This pull request removes the deploy-demo target from the Makefile. The deploy-demo target was responsible for deploying the documentation demo site to the S3 bucket s3://docs-ci-cd-demo/site/. The removal includes both the .PHONY declaration and the actual target implementation. The deploy-demo-branch target remains intact, allowing deployment of documentation demo sites to branch-specific directories within the same S3 bucket.

The change simplifies the Makefile by eliminating a deployment option that may no longer be necessary or used, potentially reducing maintenance overhead and the risk of deploying to an incorrect environment.

Test Suggestions

  • Verify that the Makefile executes without errors after the removal of the 'deploy-demo' target.
  • Ensure that the 'deploy-demo-branch' target still functions correctly and deploys to the expected S3 path.
  • Check for any documentation or scripts that reference the removed 'deploy-demo' target and update them accordingly.
  • Test the deployment process to ensure no unintended side effects occur due to the removal of the 'deploy-demo' target.

Copy link
Contributor

A PR preview is available: Preview URL

1 similar comment
Copy link
Contributor

A PR preview is available: Preview URL

Copy link
Collaborator

@validbeck validbeck left a comment

Choose a reason for hiding this comment

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

Let's gooo 🎉

@nrichers nrichers merged commit 39d78c0 into main Mar 21, 2025
5 checks passed
@nrichers nrichers deleted the remove-deploy-demo-action branch March 21, 2025 00:23
nrichers added a commit that referenced this pull request Mar 21, 2025
Co-authored-by: Nik Richers <nik@validmind.ai>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infrastructure Docs infra changes internal Not to be externalized in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants