Skip to content

Remove rendered site output from repo#308

Merged
nrichers merged 4 commits intomainfrom
nrichers/sc-6106/remove-rendered-site-output-from-prs
Sep 3, 2024
Merged

Remove rendered site output from repo#308
nrichers merged 4 commits intomainfrom
nrichers/sc-6106/remove-rendered-site-output-from-prs

Conversation

@nrichers
Copy link
Copy Markdown
Collaborator

@nrichers nrichers commented Sep 3, 2024

Internal Notes for Reviewers

This PR

  • removes the site/_site/ folder with the rendered docs site from the repo; AND
  • adds the folder to the .gitignore file to prevent it from being re-added

These changes add the following highlight from our docs CI/CD deployment proposal. The output is no longer needed in the repo as it will now be rendered on the fly when needed for PR previews or staging and prod sites.

image

Proof it works

Run quarto render and enter git status (gst alias) and there should be no output files to commit:

image

How to test

Check out this PR locally, run quarto render and then git status. There should be no new or modified files shown.

External Release Notes

@nrichers nrichers added infrastructure Docs infra changes internal Not to be externalized in the release notes labels Sep 3, 2024
@nrichers nrichers requested a review from validbeck September 3, 2024 00:08
Copy link
Copy Markdown
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.

It works let's gooo

@nrichers nrichers merged commit 9bcdbda into main Sep 3, 2024
@nrichers nrichers deleted the nrichers/sc-6106/remove-rendered-site-output-from-prs branch September 3, 2024 17:46
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.

2 participants