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

Add GitHub Action for site and preview deployments #159

Merged
merged 3 commits into from
Aug 13, 2024
Merged

Conversation

danielledeleo
Copy link
Contributor

We now self-host the Unit docs site on Azure alongside other NGINX docs. This change adds a GitHub Action to build, preview, and deploy to the new environment. Some Netlify functionality, like previews has been replicated.

Related PR: nginxinc/kubernetes-ingress#6027

Action Documentation: https://github.com/nginxinc/docs-actions/tree/main?tab=readme-ov-file#docs-actions

@danielledeleo
Copy link
Contributor Author

I won't be able to test this action until it is merged (🐓🥚). Merging it will not affect the live site, as deployments to production must be done by running the workflow manually.

Copy link
Contributor

@javorszky javorszky left a comment

Choose a reason for hiding this comment

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

A single non-blocking question due to the different nature of these docs compared to other NGINX docs.

Otherwise my assumption is that a lot of additional steps will be needed before we can actually make use of this, namely:

  • making sure that we have the correct Azure credentials set up, and stored
  • making sure that all of the paths are correct for the sphinx deployment

.github/workflows/docs-build-push.yml Outdated Show resolved Hide resolved
@callahad
Copy link
Collaborator

Concerned about dropping the redirects / url proxying from netlify.toml without the commit message saying anything about what's happened to them.

...also a bit nervous about the record of those disappearing from this repo; knowing to redirect /download and transparently proxy /download/* seems pretty crucial to making the site actually work.

@nginx-jack
Copy link
Collaborator

Concerned about dropping the redirects / url proxying from netlify.toml without the commit message saying anything about what's happened to them.

...also a bit nervous about the record of those disappearing from this repo; knowing to redirect /download and transparently proxy /download/* seems pretty crucial to making the site actually work.

We can add a commit message explaining that those redirects now live in a private repository as an NGINX configuration, and add something about it to a readme as well, so if/when unit changes hosting again, we make sure we don't lose those redirects.

I'd like to get to a point, like netlify, where each documentation resource can provide it's own NGINX snippet containing it's required proxying and redirects, but we're not there yet unfortunately.

Copy link

github-actions bot commented Aug 6, 2024

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/unit/159/

@avahahn avahahn merged commit 2c6fb03 into main Aug 13, 2024
1 check passed
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.

5 participants